{"openapi":"3.0.0","info":{"title":"ConnexCS Control Panel API","version":"0.0.2","license":{"name":"BSD-2-Clause","url":"https://opensource.org/licenses/BSD-2-Clause"},"description":"Specification JSONs: [v3](/api-spec/v3).\n\nConnexCS API Application - A comprehensive API for managing VoIP switching, routing, and customer management.\n\n## Authentication\n\nThis API supports two authentication methods. Send either credential in the `Authorization` header.\n- **OAuth 2.0**: Use an access token obtained through the authorization code flow\n- **Opaque Token**: Use a long-lived `cxo.<id>.<secret>` API token; it is exchanged securely by the API\n\n## Rate Limiting\n\nAPI requests are rate limited. Please implement appropriate backoff strategies.\n\n## Pagination\n\nList endpoints support `_limit` and `_offset` query parameters for pagination.","contact":{"name":"ConnexCS Support","url":"https://www.connexcs.com","email":"support@connexcs.com"}},"externalDocs":{"description":"ConnexCS Documentation","url":"https://docs.connexcs.com"},"servers":[{"url":"https://app.connexcs.com","description":"ConnexCS Production API Endpoint"}],"security":[{"oAuth2":[]},{"opaqueToken":[]}],"tags":[{"name":"Active Queries","description":"Operations related to Active Queries"},{"name":"Alert","description":"Operations related to Alert"},{"name":"Alert Global","description":"Operations related to Alert Global"},{"name":"Alias","description":"Operations related to Alias"},{"name":"Analytics","description":"Operations related to Analytics"},{"name":"Anvil Branches","description":"Operations related to Anvil Branches"},{"name":"Anvil Components","description":"Operations related to Anvil Components"},{"name":"Anvil Diff","description":"Operations related to Anvil Diff"},{"name":"Anvil Domains","description":"Operations related to Anvil Domains"},{"name":"Anvil File Lookup","description":"Operations related to Anvil File Lookup"},{"name":"Anvil Files","description":"Operations related to Anvil Files"},{"name":"Anvil Projects","description":"Operations related to Anvil Projects"},{"name":"Anvil Publish","description":"Operations related to Anvil Publish"},{"name":"Anvil Registry","description":"Operations related to Anvil Registry"},{"name":"Anvil ScriptForge Publish","description":"Operations related to Anvil ScriptForge Publish"},{"name":"Anvil Snapshots","description":"Operations related to Anvil Snapshots"},{"name":"Anvil Starters","description":"Operations related to Anvil Starters"},{"name":"Any Edge Domain","description":"Operations related to Any Edge Domain"},{"name":"Anycast Loadbalancer","description":"Operations related to Anycast Loadbalancer"},{"name":"Anycast Loadbalancer Destination","description":"Operations related to Anycast Loadbalancer Destination"},{"name":"Auth","description":"Operations related to Auth"},{"name":"Breakout","description":"Operations related to Breakout"},{"name":"Button","description":"Operations related to Button"},{"name":"CX CLI Proxy","description":"Operations related to CX CLI Proxy"},{"name":"Calling Card","description":"Operations related to Calling Card"},{"name":"Card","description":"Operations related to Card"},{"name":"Card Revision","description":"Operations related to Card Revision"},{"name":"Carrier","description":"Operations related to Carrier"},{"name":"Cdr","description":"Operations related to Cdr"},{"name":"Cdr Action","description":"Operations related to Cdr Action"},{"name":"Change Log","description":"Operations related to Change Log"},{"name":"Circuit Test","description":"Operations related to Circuit Test"},{"name":"Circuit Test Schedule","description":"Operations related to Circuit Test Schedule"},{"name":"Class 5 - AI Agent","description":"Operations related to Class 5 - AI Agent"},{"name":"Class 5 AI Agent Provider","description":"Operations related to Class 5 AI Agent Provider"},{"name":"Class 5 AI Agent Task","description":"Operations related to Class 5 AI Agent Task"},{"name":"Class 5 AI Agent Test","description":"Operations related to Class 5 AI Agent Test"},{"name":"Class 5 App","description":"Operations related to Class 5 App"},{"name":"Class 5 Audio","description":"Operations related to Class 5 Audio"},{"name":"Class 5 Call Center","description":"Operations related to Class 5 Call Center"},{"name":"Class 5 Call Center Consumer","description":"Operations related to Class 5 Call Center Consumer"},{"name":"Class 5 Conference","description":"Operations related to Class 5 Conference"},{"name":"Class 5 Directory","description":"Operations related to Class 5 Directory"},{"name":"Class 5 Group","description":"Operations related to Class 5 Group"},{"name":"Class 5 Group Member","description":"Operations related to Class 5 Group Member"},{"name":"Class 5 IVR","description":"Operations related to Class 5 IVR"},{"name":"Class 5 System Dialplan","description":"Operations related to Class 5 System Dialplan"},{"name":"Cli","description":"Operations related to Cli"},{"name":"Cli Global","description":"Operations related to Cli Global"},{"name":"Connexamine","description":"Operations related to Connexamine"},{"name":"Contact","description":"Operations related to Contact"},{"name":"Contract","description":"Operations related to Contract"},{"name":"Customer","description":"Operations related to Customer"},{"name":"Cx Package","description":"Operations related to Cx Package"},{"name":"DID Provision","description":"Operations related to DID Provision"},{"name":"Dev Button","description":"Operations related to Dev Button"},{"name":"Dev DB","description":"Operations related to Dev DB"},{"name":"Developer - Domain","description":"Operations related to Developer - Domain"},{"name":"Developer - Key Value Store","description":"Operations related to Developer - Key Value Store"},{"name":"Dialog","description":"Operations related to Dialog"},{"name":"Did","description":"Operations related to Did"},{"name":"Document","description":"Operations related to Document"},{"name":"Form Builder","description":"Operations related to Form Builder"},{"name":"Fraud Profile","description":"Operations related to Fraud Profile"},{"name":"Fraud Rule","description":"Operations related to Fraud Rule"},{"name":"Graphite","description":"Operations related to Graphite"},{"name":"Hearth Data","description":"Operations related to Hearth Data"},{"name":"Hearth Jobs","description":"Operations related to Hearth Jobs"},{"name":"Hearth Permissions","description":"Operations related to Hearth Permissions"},{"name":"Hearth Schemas","description":"Operations related to Hearth Schemas"},{"name":"Hearth Tables","description":"Operations related to Hearth Tables"},{"name":"Hearth Whoami","description":"Operations related to Hearth Whoami"},{"name":"Internal Number Block","description":"Operations related to Internal Number Block"},{"name":"Invoice","description":"Operations related to Invoice"},{"name":"Invoice Line","description":"Operations related to Invoice Line"},{"name":"Invoice Payment","description":"Operations related to Invoice Payment"},{"name":"JWT Refresh Tokens","description":"Operations related to JWT Refresh Tokens"},{"name":"Jobs (New)","description":"Operations related to Jobs (New)"},{"name":"Jobs (Userspace)","description":"Operations related to Jobs (Userspace)"},{"name":"KYB Didit","description":"Operations related to KYB Didit"},{"name":"KYC","description":"Operations related to KYC"},{"name":"KYC Didit","description":"Operations related to KYC Didit"},{"name":"Knowledge Base","description":"Operations related to Knowledge Base"},{"name":"Knowledge Base Source","description":"Operations related to Knowledge Base Source"},{"name":"Lang","description":"Operations related to Lang"},{"name":"Latest","description":"Operations related to Latest"},{"name":"Log","description":"Operations related to Log"},{"name":"Lookup","description":"Operations related to Lookup"},{"name":"MCP Proxy","description":"Operations related to MCP Proxy"},{"name":"MetricsQL","description":"Operations related to MetricsQL"},{"name":"Neutrafix","description":"Operations related to Neutrafix"},{"name":"Opaque Tokens","description":"Operations related to Opaque Tokens"},{"name":"Package","description":"Operations related to Package"},{"name":"Payment","description":"Operations related to Payment"},{"name":"Paypal Log","description":"Operations related to Paypal Log"},{"name":"Phonebook","description":"Operations related to Phonebook"},{"name":"Phonebook Phone","description":"Operations related to Phonebook Phone"},{"name":"Project","description":"Operations related to Project"},{"name":"Recording","description":"Operations related to Recording"},{"name":"Regex Generate","description":"Operations related to Regex Generate"},{"name":"Report Schedule","description":"Operations related to Report Schedule"},{"name":"Rev","description":"Operations related to Rev"},{"name":"Road Map","description":"Operations related to Road Map"},{"name":"Route Strategy","description":"Operations related to Route Strategy"},{"name":"Routing","description":"Operations related to Routing"},{"name":"Routing Global","description":"Operations related to Routing Global"},{"name":"Rule","description":"Operations related to Rule"},{"name":"SIP User","description":"Operations related to SIP User"},{"name":"SIP User ng911","description":"Operations related to SIP User ng911"},{"name":"SMS User","description":"Operations related to SMS User"},{"name":"Script Forge","description":"Operations related to Script Forge"},{"name":"Setup API","description":"Operations related to Setup API"},{"name":"Setup Account","description":"Operations related to Setup Account"},{"name":"Setup Account Manager Comission","description":"Operations related to Setup Account Manager Comission"},{"name":"Setup App","description":"Operations related to Setup App"},{"name":"Setup Audit","description":"Operations related to Setup Audit"},{"name":"Setup Button","description":"Operations related to Setup Button"},{"name":"Setup Call Recording","description":"Operations related to Setup Call Recording"},{"name":"Setup Cert","description":"Operations related to Setup Cert"},{"name":"Setup Cluster","description":"Operations related to Setup Cluster"},{"name":"Setup Component","description":"Operations related to Setup Component"},{"name":"Setup Contract","description":"Operations related to Setup Contract"},{"name":"Setup Cx Packages","description":"Operations related to Setup Cx Packages"},{"name":"Setup DNS","description":"Operations related to Setup DNS"},{"name":"Setup Datastore","description":"Operations related to Setup Datastore"},{"name":"Setup Delayed","description":"Operations related to Setup Delayed"},{"name":"Setup Document","description":"Operations related to Setup Document"},{"name":"Setup Domain","description":"Operations related to Setup Domain"},{"name":"Setup Firewall","description":"Operations related to Setup Firewall"},{"name":"Setup Group","description":"Operations related to Setup Group"},{"name":"Setup Group Permission","description":"Operations related to Setup Group Permission"},{"name":"Setup Job","description":"Operations related to Setup Job"},{"name":"Setup Keys","description":"Operations related to Setup Keys"},{"name":"Setup Language","description":"Operations related to Setup Language"},{"name":"Setup Number List","description":"Operations related to Setup Number List"},{"name":"Setup Package","description":"Operations related to Setup Package"},{"name":"Setup Page","description":"Operations related to Setup Page"},{"name":"Setup Passkey","description":"Operations related to Setup Passkey"},{"name":"Setup Payment","description":"Operations related to Setup Payment"},{"name":"Setup Prefix Set","description":"Operations related to Setup Prefix Set"},{"name":"Setup Query","description":"Operations related to Setup Query"},{"name":"Setup RTP","description":"Operations related to Setup RTP"},{"name":"Setup RTP Block","description":"Operations related to Setup RTP Block"},{"name":"Setup RTP Zone","description":"Operations related to Setup RTP Zone"},{"name":"Setup Repo","description":"Operations related to Setup Repo"},{"name":"Setup Reseller","description":"Operations related to Setup Reseller"},{"name":"Setup SIP Profile","description":"Operations related to Setup SIP Profile"},{"name":"Setup Server","description":"Operations related to Setup Server"},{"name":"Setup Servercert","description":"Operations related to Setup Servercert"},{"name":"Setup Statement","description":"Operations related to Setup Statement"},{"name":"Setup Stir Shaken Cert","description":"Operations related to Setup Stir Shaken Cert"},{"name":"Setup Stripe Card","description":"Operations related to Setup Stripe Card"},{"name":"Setup Stripe Webhook","description":"Operations related to Setup Stripe Webhook"},{"name":"Setup System Log","description":"Operations related to Setup System Log"},{"name":"Setup Template","description":"Operations related to Setup Template"},{"name":"Setup Transcription Classification Policy","description":"Operations related to Setup Transcription Classification Policy"},{"name":"Setup Transcription Classification Policy Condition","description":"Operations related to Setup Transcription Classification Policy Condition"},{"name":"Setup Transcription Classifier","description":"Operations related to Setup Transcription Classifier"},{"name":"Setup Transcription Classifier Assignment","description":"Operations related to Setup Transcription Classifier Assignment"},{"name":"Setup Transcription Classifier Question","description":"Operations related to Setup Transcription Classifier Question"},{"name":"Setup Transcription Query Profile","description":"Operations related to Setup Transcription Query Profile"},{"name":"Setup Usage","description":"Operations related to Setup Usage"},{"name":"Setup User","description":"Operations related to Setup User"},{"name":"Setup User Certification","description":"Operations related to Setup User Certification"},{"name":"Setup Userspace","description":"Operations related to Setup Userspace"},{"name":"Setup Vars","description":"Operations related to Setup Vars"},{"name":"Setup Voucher","description":"Operations related to Setup Voucher"},{"name":"Setup Webphone","description":"Operations related to Setup Webphone"},{"name":"Sign","description":"Operations related to Sign"},{"name":"Sip Device","description":"Operations related to Sip Device"},{"name":"Sip Device Line","description":"Operations related to Sip Device Line"},{"name":"Socket","description":"Operations related to Socket"},{"name":"Status Component","description":"Operations related to Status Component"},{"name":"Status Incident","description":"Operations related to Status Incident"},{"name":"Stream","description":"Operations related to Stream"},{"name":"Support Ticket","description":"Operations related to Support Ticket"},{"name":"Switch","description":"Operations related to Switch"},{"name":"Tag","description":"Operations related to Tag"},{"name":"Tool","description":"Operations related to Tool"},{"name":"Transcribe","description":"Operations related to Transcribe"},{"name":"Transcription","description":"Operations related to Transcription"},{"name":"Transcription Report","description":"Operations related to Transcription Report"},{"name":"Transformation","description":"Operations related to Transformation"},{"name":"Tts","description":"Operations related to Tts"},{"name":"User Location","description":"Operations related to User Location"},{"name":"Voicemail","description":"Operations related to Voicemail"},{"name":"Weylon","description":"Operations related to Weylon"}],"components":{"securitySchemes":{"oAuth2":{"type":"oauth2","description":"OAuth 2.0 authorization code flow. Send the resulting access token as a Bearer token.","flows":{"authorizationCode":{"authorizationUrl":"https://auth.connexcs.com/authorize","tokenUrl":"https://auth.connexcs.com/token","scopes":{"api:read":"Read API resources","api:write":"Create, update, and delete API resources"}}}},"opaqueToken":{"type":"http","scheme":"bearer","bearerFormat":"cxo.<id>.<secret>","description":"Long-lived opaque API token. Send the token in the Authorization header using the Bearer scheme."}},"responses":{"UnauthorizedError":{"description":"Authentication information is missing or invalid","headers":{"WWW_Authenticate":{"schema":{"type":"string"}}}}},"schemas":{"SuccessResponse":{"type":"object","properties":{"status":{"type":"string","description":"Operation status","example":"OK"}},"example":{"status":"OK"}},"ErrorResponse":{"type":"object","properties":{"error":{"type":"string","description":"Error type or code","example":"Bad Request"},"message":{"type":"string","description":"Detailed error message","example":"Validation failed for field \"name\""}},"example":{"error":"Bad Request","message":"Validation failed"}},"CreateResponse":{"type":"object","properties":{"id":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"The ID of the newly created record","example":12345},"status":{"type":"string","description":"Operation status","example":"OK"}},"example":{"id":12345,"status":"OK"}},"PaginatedResponse":{"type":"object","properties":{"data":{"type":"array","items":{},"description":"Array of records"},"total":{"type":"integer","description":"Total number of records matching the query","example":150},"limit":{"type":"integer","description":"Maximum records per page","example":50},"offset":{"type":"integer","description":"Number of records skipped","example":0}}},"supportTicket":{"type":"object","properties":{"body":{"description":"Body","type":"object","additionalProperties":true,"example":{}},"createdBy":{"description":"Created By","type":"string","example":"example_createdBy"},"createdAt":{"description":"Created At","type":"string","example":"example_createdAt"}},"example":{"body":{},"createdBy":"example_createdBy","createdAt":"example_createdAt"}},"alertGlobal":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"title":{"description":"Title","type":"string","maxLength":100,"example":"Example Name"},"area":{"description":"Area","type":"string","nullable":false,"maxLength":50,"example":"example_area"},"operator":{"description":"Operator","type":"string","enum":["<","<=","=",">",">=","always"],"example":"<"},"threshold":{"description":"Threshold","type":"number","maxLength":10,"example":99.99},"reset_threshold":{"description":"Reset Threshold","type":"number","maxLength":10,"example":99.99},"sample_period":{"description":"Sample Period","type":"integer","maxLength":10,"minimum":0,"example":123},"template":{"description":"Template","type":"string","maxLength":100,"example":"example_template"},"penalty":{"description":"Penalty","type":"integer","maxLength":10,"minimum":0,"example":123},"cron":{"description":"Cron","type":"string","maxLength":100,"example":"example_cron"},"sandbox_id":{"description":"Sandbox Id","type":"integer","maxLength":10,"minimum":0,"example":1},"last_ran":{"description":"Last Ran","type":"string","format":"date-time","nullable":true,"maxLength":6,"example":"2025-01-17T10:30:00Z"},"next_run":{"description":"Next Run","type":"string","format":"date-time","maxLength":6,"example":"2025-01-17T10:30:00Z"},"tag":{"description":"Tag","type":"string","maxLength":255,"example":"example_tag"},"notice_level":{"description":"Notice Level","type":"string","enum":["none","warning","error"],"nullable":false,"default":"none","example":"none"},"table_change":{"description":"Table Change","type":"string","maxLength":255,"example":"example_table_change"},"query":{"description":"Query","type":"string","example":"Sample query text content"}},"example":{"id":12345,"account_id":1,"title":"Example Name","area":"example_area","operator":"<","threshold":99.99,"reset_threshold":99.99,"sample_period":123,"template":"example_template","penalty":123,"cron":"example_cron","sandbox_id":1,"last_ran":"2025-01-17T10:30:00Z","next_run":"2025-01-17T10:30:00Z","tag":"example_tag","notice_level":"none","table_change":"example_table_change","query":"Sample query text content"}},"alertGlobalInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"title":{"description":"Title","type":"string","maxLength":100,"example":"Example Name"},"area":{"description":"Area","type":"string","nullable":false,"maxLength":50,"example":"example_area"},"operator":{"description":"Operator","type":"string","enum":["<","<=","=",">",">=","always"],"example":"<"},"threshold":{"description":"Threshold","type":"number","maxLength":10,"example":99.99},"reset_threshold":{"description":"Reset Threshold","type":"number","maxLength":10,"example":99.99},"sample_period":{"description":"Sample Period","type":"integer","maxLength":10,"minimum":0,"example":123},"template":{"description":"Template","type":"string","maxLength":100,"example":"example_template"},"penalty":{"description":"Penalty","type":"integer","maxLength":10,"minimum":0,"example":123},"cron":{"description":"Cron","type":"string","maxLength":100,"example":"example_cron"},"sandbox_id":{"description":"Sandbox Id","type":"integer","maxLength":10,"minimum":0,"example":1},"last_ran":{"description":"Last Ran","type":"string","format":"date-time","nullable":true,"maxLength":6,"example":"2025-01-17T10:30:00Z"},"next_run":{"description":"Next Run","type":"string","format":"date-time","maxLength":6,"example":"2025-01-17T10:30:00Z"},"tag":{"description":"Tag","type":"string","maxLength":255,"example":"example_tag"},"notice_level":{"description":"Notice Level","type":"string","enum":["none","warning","error"],"nullable":false,"default":"none","example":"none"},"table_change":{"description":"Table Change","type":"string","maxLength":255,"example":"example_table_change"},"query":{"description":"Query","type":"string","example":"Sample query text content"}},"example":{"id":12345,"account_id":1,"title":"Example Name","area":"example_area","operator":"<","threshold":99.99,"reset_threshold":99.99,"sample_period":123,"template":"example_template","penalty":123,"cron":"example_cron","sandbox_id":1,"last_ran":"2025-01-17T10:30:00Z","next_run":"2025-01-17T10:30:00Z","tag":"example_tag","notice_level":"none","table_change":"example_table_change","query":"Sample query text content"},"required":["area","notice_level"]},"button":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":11,"example":1},"company_id":{"description":"Company Id","type":"integer","maxLength":10,"minimum":0,"example":1},"app_id":{"description":"App Id","type":"string","maxLength":40,"example":1},"anvil_path":{"description":"Anvil Path","type":"string","maxLength":255,"example":"example_anvil_path"},"label":{"description":"Label","type":"string","maxLength":255,"example":"example_label"},"icon":{"description":"Icon","type":"string","maxLength":255,"example":"example_icon"},"tooltip":{"description":"Tooltip","type":"string","maxLength":500,"example":"example_tooltip"},"type":{"description":"Type","type":"string","maxLength":30,"example":"example_type"},"area":{"description":"Area","type":"string","maxLength":255,"default":"cp","example":"example_area"},"placement":{"description":"Placement","type":"string","maxLength":255,"example":"example_placement"},"min_select":{"description":"Min Select","type":"integer","maxLength":255,"minimum":0,"example":123},"max_select":{"description":"Max Select","type":"integer","maxLength":255,"minimum":0,"example":123},"sandbox_id":{"description":"Sandbox Id","type":"integer","maxLength":10,"minimum":0,"example":1},"fn":{"description":"Fn","type":"string","maxLength":255,"default":"main","example":"example_fn"},"form_id":{"description":"Form Id","type":"integer","maxLength":10,"minimum":0,"example":1},"page_id":{"description":"Page Id","type":"string","maxLength":40,"example":1},"sort_order":{"description":"Sort Order","type":"integer","maxLength":255,"minimum":0,"default":"50","example":1},"company_ids":{"description":"Company Ids","type":"string","maxLength":5000,"example":"example_company_ids"},"open_mode":{"description":"Open Mode","type":"string","enum":["page","dialog"],"example":"page"}},"example":{"id":12345,"account_id":1,"company_id":1,"app_id":1,"anvil_path":"example_anvil_path","label":"example_label","icon":"example_icon","tooltip":"example_tooltip","type":"example_type","area":"example_area","placement":"example_placement","min_select":123,"max_select":123,"sandbox_id":1,"fn":"example_fn","form_id":1,"page_id":1,"sort_order":1,"company_ids":"example_company_ids","open_mode":"page"}},"callingCard":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":20,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"customer_rate_card":{"description":"Customer Rate Card","type":"string","maxLength":10,"example":"example_customer_rate_card"},"credit":{"description":"Credit","type":"number","maxLength":10,"example":99.99},"status":{"description":"Status","type":"string","maxLength":50,"example":"Active"},"template_customer_id":{"description":"Template Customer Id","type":"integer","maxLength":10,"minimum":0,"example":1},"min_activation":{"description":"Min Activation","type":"number","maxLength":6,"example":99.99},"multiplier":{"description":"Multiplier","type":"number","maxLength":6,"example":99.99},"addition":{"description":"Addition","type":"number","maxLength":6,"example":99.99}},"example":{"id":12345,"account_id":1,"customer_rate_card":"example_customer_rate_card","credit":99.99,"status":"Active","template_customer_id":1,"min_activation":99.99,"multiplier":99.99,"addition":99.99}},"callingCardInput":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":20,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"customer_rate_card":{"description":"Customer Rate Card","type":"string","maxLength":10,"example":"example_customer_rate_card"},"credit":{"description":"Credit","type":"number","maxLength":10,"example":99.99},"status":{"description":"Status","type":"string","maxLength":50,"example":"Active"},"template_customer_id":{"description":"Template Customer Id","type":"integer","maxLength":10,"minimum":0,"example":1},"min_activation":{"description":"Min Activation","type":"number","maxLength":6,"example":99.99},"multiplier":{"description":"Multiplier","type":"number","maxLength":6,"example":99.99},"addition":{"description":"Addition","type":"number","maxLength":6,"example":99.99}},"example":{"id":12345,"account_id":1,"customer_rate_card":"example_customer_rate_card","credit":99.99,"status":"Active","template_customer_id":1,"min_activation":99.99,"multiplier":99.99,"addition":99.99}},"card":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":255,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"company_id":{"description":"Company Id","type":"integer","maxLength":10,"minimum":0,"example":1},"reseller_id":{"description":"Reseller Id","type":"integer","maxLength":10,"minimum":0,"example":1},"reseller_ids":{"description":"Reseller Ids","type":"string","maxLength":255,"example":"example_reseller_ids"},"system_id":{"description":"System Id","type":"string","maxLength":50,"example":1},"system_num":{"description":"System Num","type":"integer","maxLength":11,"example":123},"name":{"description":"Name","type":"string","nullable":false,"maxLength":200,"example":"Example Name"},"notes":{"description":"Notes","type":"string","example":"Sample notes text content"},"public_options":{"description":"Public Options","type":"string","maxLength":255,"example":"example_public_options"},"public_name":{"description":"Public Name","type":"string","maxLength":200,"example":"example_public_name"},"public_notes":{"description":"Public Notes","type":"string","example":"Sample public_notes text content"},"presentation":{"description":"Presentation","type":"string","maxLength":255,"example":"example_presentation"},"collapse":{"description":"Collapse","type":"string","maxLength":255,"example":"example_collapse"},"import_url":{"description":"Import Url","type":"string","format":"uri","maxLength":200,"example":"example_import_url"},"import_map":{"description":"Import Map","type":"string","nullable":false,"maxLength":255,"example":"example_import_map"},"import_row_start":{"description":"Import Row Start","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":123},"import_remove_prefix":{"description":"Import Remove Prefix","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"import_prepend_prefix":{"description":"Import Prepend Prefix","type":"string","maxLength":20,"example":"example_import_prepend_prefix"},"export_map":{"description":"Export Map","type":"string","nullable":false,"maxLength":255,"example":"example_export_map"},"lcr_map":{"description":"Lcr Map","type":"string","maxLength":255,"example":"example_lcr_map"},"rate_formula":{"description":"Rate Formula","type":"string","maxLength":255,"example":"example_rate_formula"},"gen_lcr":{"description":"Gen Lcr","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"1","example":1},"trust_fail":{"description":"Trust Fail","type":"integer","maxLength":3,"minimum":0,"default":"1","example":1},"currency":{"description":"Currency","type":"string","maxLength":4,"example":"USD"},"tech_prefix":{"description":"Tech Prefix","type":"string","nullable":false,"maxLength":10,"example":"example_tech_prefix"},"lrn":{"description":"Lrn","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"override_lcr":{"description":"Override Lcr","type":"string","maxLength":500,"example":"example_override_lcr"},"connexcs_permission":{"description":"Connexcs Permission","type":"string","maxLength":500,"example":"example_connexcs_permission"},"stale":{"description":"Stale","type":"integer","maxLength":1,"minimum":0,"default":"0","example":1},"filtered_transform":{"description":"Filtered Transform","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"dyn_routing":{"description":"Dyn Routing","type":"string","maxLength":500,"example":"example_dyn_routing"},"active_rev":{"description":"Active Rev","type":"integer","maxLength":10,"minimum":0,"example":true},"cli_restrict":{"description":"Cli Restrict","type":"string","maxLength":5000,"example":"example_cli_restrict"},"paid_restrict":{"description":"Paid Restrict","type":"string","maxLength":5000,"example":"example_paid_restrict"},"strategy":{"description":"Strategy","type":"string","enum":["LCR","Best ACD","Best ASR","LCR Performance","Random","Reverse LCR","Round Robin"],"default":"LCR","example":"LCR"},"billing_precision":{"description":"Billing Precision","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"4","example":1},"rounding_method":{"description":"Rounding Method","type":"string","enum":["up","down","half-up","half-down"],"default":"half-up","example":"up"},"duration_rounding_method":{"description":"Duration Rounding Method","type":"string","enum":["up","down","half-up","half-down"],"default":"half-up","example":"up"},"direction":{"description":"Direction","type":"string","enum":["origination","termination"],"nullable":false,"example":"origination"},"delayed_bye":{"description":"Delayed Bye","type":"integer","maxLength":3,"minimum":0,"example":1},"delayed_bye_mcd":{"description":"Delayed Bye Mcd","type":"integer","maxLength":3,"minimum":0,"example":1},"delayed_bye_charge_customer":{"description":"Delayed Bye Charge Customer","type":"integer","maxLength":3,"minimum":0,"example":1},"sms_url":{"description":"Sms Url","type":"string","format":"uri","maxLength":255,"example":"example_sms_url"},"asr_plus":{"description":"Asr Plus","type":"integer","maxLength":3,"minimum":0,"example":1},"contract_id":{"description":"Contract Id","type":"integer","maxLength":10,"minimum":0,"example":1},"default_rtp":{"description":"Default Rtp","type":"integer","maxLength":3,"minimum":0,"default":"100","example":1},"force_rtp_id":{"description":"Force Rtp Id","type":"integer","maxLength":3,"minimum":0,"example":1},"capped_rate":{"description":"Capped Rate","type":"number","maxLength":8,"example":99.99},"block_connect_cost":{"description":"Block Connect Cost","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":99.99},"profit_assurance":{"description":"Profit Assurance","type":"number","maxLength":3,"example":99.99},"manual_ordering":{"description":"Manual Ordering","type":"integer","maxLength":3,"minimum":0,"default":"0","example":1},"channels":{"description":"Channels","type":"integer","maxLength":11,"minimum":0,"default":"0","example":123},"cps":{"description":"Cps","type":"integer","maxLength":10,"minimum":0,"default":"0","example":123},"block_destination_type":{"description":"Block Destination Type","type":"string","maxLength":255,"example":"example_block_destination_type"},"ptime":{"description":"Ptime","type":"integer","maxLength":10,"minimum":0,"default":"0","example":123},"origin_billing_source":{"description":"Origin Billing Source","type":"string","nullable":false,"maxLength":255,"example":"example_origin_billing_source"},"origin_billing_destination":{"description":"Origin Billing Destination","type":"string","nullable":false,"maxLength":255,"example":"example_origin_billing_destination"}},"example":{"id":12345,"account_id":1,"company_id":1,"reseller_id":1,"reseller_ids":"example_reseller_ids","system_id":1,"system_num":123,"name":"Example Name","notes":"Sample notes text content","public_options":"example_public_options","public_name":"example_public_name","public_notes":"Sample public_notes text content","presentation":"example_presentation","collapse":"example_collapse","import_url":"example_import_url","import_map":"example_import_map","import_row_start":123,"import_remove_prefix":1,"import_prepend_prefix":"example_import_prepend_prefix","export_map":"example_export_map","lcr_map":"example_lcr_map","rate_formula":"example_rate_formula","gen_lcr":1,"trust_fail":1,"currency":"USD","tech_prefix":"example_tech_prefix","lrn":1,"override_lcr":"example_override_lcr","connexcs_permission":"example_connexcs_permission","stale":1,"filtered_transform":1,"dyn_routing":"example_dyn_routing","active_rev":true,"cli_restrict":"example_cli_restrict","paid_restrict":"example_paid_restrict","strategy":"LCR","billing_precision":1,"rounding_method":"up","duration_rounding_method":"up","direction":"origination","delayed_bye":1,"delayed_bye_mcd":1,"delayed_bye_charge_customer":1,"sms_url":"example_sms_url","asr_plus":1,"contract_id":1,"default_rtp":1,"force_rtp_id":1,"capped_rate":99.99,"block_connect_cost":99.99,"profit_assurance":99.99,"manual_ordering":1,"channels":123,"cps":123,"block_destination_type":"example_block_destination_type","ptime":123,"origin_billing_source":"example_origin_billing_source","origin_billing_destination":"example_origin_billing_destination"}},"cardInput":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":255,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"company_id":{"description":"Company Id","type":"integer","maxLength":10,"minimum":0,"example":1},"reseller_id":{"description":"Reseller Id","type":"integer","maxLength":10,"minimum":0,"example":1},"reseller_ids":{"description":"Reseller Ids","type":"string","maxLength":255,"example":"example_reseller_ids"},"system_id":{"description":"System Id","type":"string","maxLength":50,"example":1},"system_num":{"description":"System Num","type":"integer","maxLength":11,"example":123},"name":{"description":"Name","type":"string","nullable":false,"maxLength":200,"example":"Example Name"},"notes":{"description":"Notes","type":"string","example":"Sample notes text content"},"public_options":{"description":"Public Options","type":"string","maxLength":255,"example":"example_public_options"},"public_name":{"description":"Public Name","type":"string","maxLength":200,"example":"example_public_name"},"public_notes":{"description":"Public Notes","type":"string","example":"Sample public_notes text content"},"presentation":{"description":"Presentation","type":"string","maxLength":255,"example":"example_presentation"},"collapse":{"description":"Collapse","type":"string","maxLength":255,"example":"example_collapse"},"import_url":{"description":"Import Url","type":"string","format":"uri","maxLength":200,"example":"example_import_url"},"import_map":{"description":"Import Map","type":"string","nullable":false,"maxLength":255,"example":"example_import_map"},"import_row_start":{"description":"Import Row Start","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":123},"import_remove_prefix":{"description":"Import Remove Prefix","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"import_prepend_prefix":{"description":"Import Prepend Prefix","type":"string","maxLength":20,"example":"example_import_prepend_prefix"},"export_map":{"description":"Export Map","type":"string","nullable":false,"maxLength":255,"example":"example_export_map"},"lcr_map":{"description":"Lcr Map","type":"string","maxLength":255,"example":"example_lcr_map"},"rate_formula":{"description":"Rate Formula","type":"string","maxLength":255,"example":"example_rate_formula"},"gen_lcr":{"description":"Gen Lcr","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"1","example":1},"trust_fail":{"description":"Trust Fail","type":"integer","maxLength":3,"minimum":0,"default":"1","example":1},"currency":{"description":"Currency","type":"string","maxLength":4,"example":"USD"},"tech_prefix":{"description":"Tech Prefix","type":"string","nullable":false,"maxLength":10,"example":"example_tech_prefix"},"lrn":{"description":"Lrn","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"override_lcr":{"description":"Override Lcr","type":"string","maxLength":500,"example":"example_override_lcr"},"connexcs_permission":{"description":"Connexcs Permission","type":"string","maxLength":500,"example":"example_connexcs_permission"},"stale":{"description":"Stale","type":"integer","maxLength":1,"minimum":0,"default":"0","example":1},"filtered_transform":{"description":"Filtered Transform","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"dyn_routing":{"description":"Dyn Routing","type":"string","maxLength":500,"example":"example_dyn_routing"},"active_rev":{"description":"Active Rev","type":"integer","maxLength":10,"minimum":0,"example":true},"cli_restrict":{"description":"Cli Restrict","type":"string","maxLength":5000,"example":"example_cli_restrict"},"paid_restrict":{"description":"Paid Restrict","type":"string","maxLength":5000,"example":"example_paid_restrict"},"strategy":{"description":"Strategy","type":"string","enum":["LCR","Best ACD","Best ASR","LCR Performance","Random","Reverse LCR","Round Robin"],"default":"LCR","example":"LCR"},"billing_precision":{"description":"Billing Precision","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"4","example":1},"rounding_method":{"description":"Rounding Method","type":"string","enum":["up","down","half-up","half-down"],"default":"half-up","example":"up"},"duration_rounding_method":{"description":"Duration Rounding Method","type":"string","enum":["up","down","half-up","half-down"],"default":"half-up","example":"up"},"direction":{"description":"Direction","type":"string","enum":["origination","termination"],"nullable":false,"example":"origination"},"delayed_bye":{"description":"Delayed Bye","type":"integer","maxLength":3,"minimum":0,"example":1},"delayed_bye_mcd":{"description":"Delayed Bye Mcd","type":"integer","maxLength":3,"minimum":0,"example":1},"delayed_bye_charge_customer":{"description":"Delayed Bye Charge Customer","type":"integer","maxLength":3,"minimum":0,"example":1},"sms_url":{"description":"Sms Url","type":"string","format":"uri","maxLength":255,"example":"example_sms_url"},"asr_plus":{"description":"Asr Plus","type":"integer","maxLength":3,"minimum":0,"example":1},"contract_id":{"description":"Contract Id","type":"integer","maxLength":10,"minimum":0,"example":1},"default_rtp":{"description":"Default Rtp","type":"integer","maxLength":3,"minimum":0,"default":"100","example":1},"force_rtp_id":{"description":"Force Rtp Id","type":"integer","maxLength":3,"minimum":0,"example":1},"capped_rate":{"description":"Capped Rate","type":"number","maxLength":8,"example":99.99},"block_connect_cost":{"description":"Block Connect Cost","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":99.99},"profit_assurance":{"description":"Profit Assurance","type":"number","maxLength":3,"example":99.99},"manual_ordering":{"description":"Manual Ordering","type":"integer","maxLength":3,"minimum":0,"default":"0","example":1},"channels":{"description":"Channels","type":"integer","maxLength":11,"minimum":0,"default":"0","example":123},"cps":{"description":"Cps","type":"integer","maxLength":10,"minimum":0,"default":"0","example":123},"block_destination_type":{"description":"Block Destination Type","type":"string","maxLength":255,"example":"example_block_destination_type"},"ptime":{"description":"Ptime","type":"integer","maxLength":10,"minimum":0,"default":"0","example":123},"origin_billing_source":{"description":"Origin Billing Source","type":"string","nullable":false,"maxLength":255,"example":"example_origin_billing_source"},"origin_billing_destination":{"description":"Origin Billing Destination","type":"string","nullable":false,"maxLength":255,"example":"example_origin_billing_destination"}},"example":{"id":12345,"account_id":1,"company_id":1,"reseller_id":1,"reseller_ids":"example_reseller_ids","system_id":1,"system_num":123,"name":"Example Name","notes":"Sample notes text content","public_options":"example_public_options","public_name":"example_public_name","public_notes":"Sample public_notes text content","presentation":"example_presentation","collapse":"example_collapse","import_url":"example_import_url","import_map":"example_import_map","import_row_start":123,"import_remove_prefix":1,"import_prepend_prefix":"example_import_prepend_prefix","export_map":"example_export_map","lcr_map":"example_lcr_map","rate_formula":"example_rate_formula","gen_lcr":1,"trust_fail":1,"currency":"USD","tech_prefix":"example_tech_prefix","lrn":1,"override_lcr":"example_override_lcr","connexcs_permission":"example_connexcs_permission","stale":1,"filtered_transform":1,"dyn_routing":"example_dyn_routing","active_rev":true,"cli_restrict":"example_cli_restrict","paid_restrict":"example_paid_restrict","strategy":"LCR","billing_precision":1,"rounding_method":"up","duration_rounding_method":"up","direction":"origination","delayed_bye":1,"delayed_bye_mcd":1,"delayed_bye_charge_customer":1,"sms_url":"example_sms_url","asr_plus":1,"contract_id":1,"default_rtp":1,"force_rtp_id":1,"capped_rate":99.99,"block_connect_cost":99.99,"profit_assurance":99.99,"manual_ordering":1,"channels":123,"cps":123,"block_destination_type":"example_block_destination_type","ptime":123,"origin_billing_source":"example_origin_billing_source","origin_billing_destination":"example_origin_billing_destination"},"required":["name","import_map","import_row_start","import_remove_prefix","export_map","gen_lcr","tech_prefix","lrn","filtered_transform","billing_precision","direction","block_connect_cost","origin_billing_source","origin_billing_destination"]},"carrier":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"reseller_id":{"description":"Reseller Id","type":"integer","maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":100,"example":"Example Name"},"alias":{"description":"Alias","type":"string","maxLength":50,"example":"example_alias"},"channels":{"description":"Channels","type":"integer","maxLength":10,"minimum":0,"example":123},"cps":{"description":"Cps","type":"number","example":1.5},"system_id":{"description":"System Id","type":"string","maxLength":50,"example":1},"status":{"description":"Status","type":"string","maxLength":50,"default":"Active","example":"Active"},"address1":{"description":"Address 1","type":"string","maxLength":200,"example":"example_address1"},"address2":{"description":"Address 2","type":"string","maxLength":200,"example":"example_address2"},"city":{"description":"City","type":"string","maxLength":100,"example":"example_city"},"county":{"description":"County","type":"string","maxLength":200,"example":10},"postcode":{"description":"Postcode","type":"string","maxLength":10,"example":"example_postcode"},"website":{"description":"Website","type":"string","format":"uri","maxLength":100,"example":"https://example.com"},"country":{"description":"Country","type":"string","maxLength":100,"example":"US"},"credit_refresh_interval":{"description":"Credit Refresh Interval","type":"integer","maxLength":8,"minimum":0,"example":123},"portal_json":{"description":"Portal Json","type":"string","example":"Sample portal_json text content"},"portal_url":{"description":"Portal Url","type":"string","format":"uri","maxLength":100,"example":"example_portal_url"},"portal_username":{"description":"Portal Username","type":"string","maxLength":50,"example":"example_portal_username"},"portal_password":{"description":"Portal Password","type":"string","format":"password","maxLength":50,"example":"example_portal_password"},"email_credit_regex":{"description":"Email Credit Regex","type":"string","maxLength":500,"example":"example_email_credit_regex"},"trace":{"description":"Trace","type":"integer","maxLength":3,"minimum":0,"example":1},"credit":{"description":"Credit","type":"number","nullable":false,"maxLength":14,"default":"0","example":99.99},"debit_limit":{"description":"Debit Limit","type":"number","nullable":false,"maxLength":14,"default":"0","example":99.99},"tax":{"description":"Tax","type":"number","nullable":false,"maxLength":8,"default":"0","example":99.99},"snapshot_credit":{"description":"Snapshot Credit","type":"number","maxLength":8,"example":99.99},"snapshot_timestamp":{"description":"Snapshot Timestamp","type":"integer","maxLength":8,"minimum":0,"example":1000000},"currency":{"description":"Currency","type":"string","maxLength":3,"example":"USD"},"paypal":{"description":"Paypal","type":"string","maxLength":50,"example":"example_paypal"},"portal_access":{"description":"Portal Access","type":"string","maxLength":500,"default":"1","example":"example_portal_access"},"is_customer":{"description":"Is Customer","type":"integer","maxLength":3,"minimum":0,"default":"0","example":true},"is_carrier":{"description":"Is Carrier","type":"integer","maxLength":3,"minimum":0,"default":"0","example":true},"last_call":{"description":"Last Call","type":"integer","nullable":true,"maxLength":20,"minimum":0,"example":1000000},"auto_login_key":{"description":"Auto Login Key","type":"string","maxLength":50,"example":"example_auto_login_key"},"connexcs_permission":{"description":"Connexcs Permission","type":"string","maxLength":500,"example":"example_connexcs_permission"},"fr_timeout":{"description":"Fr Timeout","type":"integer","maxLength":3,"minimum":0,"default":"30","example":1},"pre_ring_timeout":{"description":"Pre Ring Timeout","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"30","example":1},"post_ring_timeout":{"description":"Post Ring Timeout","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"120","example":1},"p_asserted_identity":{"description":"P Asserted Identity","type":"string","enum":["default","remove","if-available","required"],"nullable":false,"default":"default","example":"default"},"reply_actions":{"description":"Reply Actions","type":"object","additionalProperties":true,"nullable":false,"maxLength":8000,"example":"example_reply_actions"},"reply_actions_json":{"description":"Reply Actions Json","type":"object","additionalProperties":true,"nullable":false,"maxLength":8000,"example":"example_reply_actions_json"},"did_api_id":{"description":"Did Api Id","type":"string","maxLength":50,"example":1},"account_api_id":{"description":"Account Api Id","type":"string","maxLength":50,"example":1},"resources_used":{"description":"Resources Used","type":"string","format":"binary","example":"base64-encoded-data"},"code_consistency":{"description":"Code Consistency","type":"number","maxLength":5,"minimum":0,"example":99.99},"code_consistency_points":{"description":"Code Consistency Points","type":"number","maxLength":5,"example":99.99},"min_payment":{"description":"Min Payment","type":"number","maxLength":8,"minimum":0,"example":99.99},"approved_cli_only":{"description":"Approved Cli Only","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"invoice_schedule":{"description":"Invoice Schedule","type":"string","enum":["day","week","bimonth","month","disabled"],"nullable":false,"default":"disabled","example":"day"},"invoice_due_days":{"description":"Invoice Due Days","type":"integer","maxLength":3,"minimum":0,"example":1},"propagate_username":{"description":"Propagate Username","type":"integer","maxLength":3,"minimum":0,"default":"0","example":1},"required":{"description":"Required","type":"array","items":{"type":"string","enum":["mobile_verification","email_verification"]},"nullable":false,"default":"","example":"mobile_verification"},"duration_latency_offset":{"description":"Duration Latency Offset","type":"number","maxLength":6,"example":99.99},"notes":{"description":"Notes","type":"string","example":"Sample notes text content"},"consec_backoff":{"description":"Consec Backoff","type":"integer","maxLength":255,"minimum":0,"default":"0","example":1},"tags":{"description":"Tags","type":"string","nullable":false,"maxLength":500,"example":"example_tags"},"vars":{"description":"Vars","type":"string","example":"Sample vars text content"},"topup_currencies":{"description":"Topup Currencies","type":"string","maxLength":255,"example":"example_topup_currencies"},"accounting_id":{"description":"Accounting Id","type":"string","maxLength":100,"example":1},"invoice_template":{"description":"Invoice Template","type":"string","maxLength":100,"example":"example_invoice_template"},"account_manager_id":{"description":"Account Manager Id","type":"integer","maxLength":10,"minimum":0,"example":1},"origid":{"description":"Origid","type":"string","maxLength":36,"default":"uuid()","example":"example_origid"},"rtp_firewall_warning":{"description":"Rtp Firewall Warning","type":"integer","maxLength":255,"minimum":0,"default":"0","example":1},"s3_size":{"description":"S 3 Size","type":"number","minimum":0,"example":1.5},"call_recording_retention_days":{"description":"Call Recording Retention Days","type":"integer","maxLength":10,"minimum":0,"default":"30","example":123},"range_holder_provider_card_id":{"description":"Range Holder Provider Card Id","type":"string","maxLength":10,"example":1},"domain_id":{"description":"Domain Id","type":"integer","maxLength":10,"minimum":0,"example":1},"cx_referal":{"description":"Cx Referal","type":"integer","nullable":false,"maxLength":3,"minimum":0,"example":1},"max_daily_spend":{"description":"Max Daily Spend","type":"number","maxLength":10,"example":99.99},"dt_restrict":{"description":"Dt Restrict","type":"object","additionalProperties":true,"maxLength":500,"example":"example_dt_restrict"},"default_stir_shaken_attestation":{"description":"Default Stir Shaken Attestation","type":"string","enum":["A","B","C"],"example":"A"},"flags":{"description":"Flags","type":"string","nullable":false,"maxLength":500,"example":"example_flags"}},"example":{"id":12345,"account_id":1,"reseller_id":1,"name":"Example Name","alias":"example_alias","channels":123,"cps":1.5,"system_id":1,"status":"Active","address1":"example_address1","address2":"example_address2","city":"example_city","county":10,"postcode":"example_postcode","website":"https://example.com","country":"US","credit_refresh_interval":123,"portal_json":"Sample portal_json text content","portal_url":"example_portal_url","portal_username":"example_portal_username","portal_password":"example_portal_password","email_credit_regex":"example_email_credit_regex","trace":1,"credit":99.99,"debit_limit":99.99,"tax":99.99,"snapshot_credit":99.99,"snapshot_timestamp":1000000,"currency":"USD","paypal":"example_paypal","portal_access":"example_portal_access","is_customer":true,"is_carrier":true,"last_call":1000000,"auto_login_key":"example_auto_login_key","connexcs_permission":"example_connexcs_permission","fr_timeout":1,"pre_ring_timeout":1,"post_ring_timeout":1,"p_asserted_identity":"default","reply_actions":"example_reply_actions","reply_actions_json":"example_reply_actions_json","did_api_id":1,"account_api_id":1,"resources_used":"base64-encoded-data","code_consistency":99.99,"code_consistency_points":99.99,"min_payment":99.99,"approved_cli_only":1,"invoice_schedule":"day","invoice_due_days":1,"propagate_username":1,"required":"mobile_verification","duration_latency_offset":99.99,"notes":"Sample notes text content","consec_backoff":1,"tags":"example_tags","vars":"Sample vars text content","topup_currencies":"example_topup_currencies","accounting_id":1,"invoice_template":"example_invoice_template","account_manager_id":1,"origid":"example_origid","rtp_firewall_warning":1,"s3_size":1.5,"call_recording_retention_days":123,"range_holder_provider_card_id":1,"domain_id":1,"cx_referal":1,"max_daily_spend":99.99,"dt_restrict":"example_dt_restrict","default_stir_shaken_attestation":"A","flags":"example_flags"}},"carrierInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"reseller_id":{"description":"Reseller Id","type":"integer","maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":100,"example":"Example Name"},"alias":{"description":"Alias","type":"string","maxLength":50,"example":"example_alias"},"channels":{"description":"Channels","type":"integer","maxLength":10,"minimum":0,"example":123},"cps":{"description":"Cps","type":"number","example":1.5},"system_id":{"description":"System Id","type":"string","maxLength":50,"example":1},"status":{"description":"Status","type":"string","maxLength":50,"default":"Active","example":"Active"},"address1":{"description":"Address 1","type":"string","maxLength":200,"example":"example_address1"},"address2":{"description":"Address 2","type":"string","maxLength":200,"example":"example_address2"},"city":{"description":"City","type":"string","maxLength":100,"example":"example_city"},"county":{"description":"County","type":"string","maxLength":200,"example":10},"postcode":{"description":"Postcode","type":"string","maxLength":10,"example":"example_postcode"},"website":{"description":"Website","type":"string","format":"uri","maxLength":100,"example":"https://example.com"},"country":{"description":"Country","type":"string","maxLength":100,"example":"US"},"credit_refresh_interval":{"description":"Credit Refresh Interval","type":"integer","maxLength":8,"minimum":0,"example":123},"portal_json":{"description":"Portal Json","type":"string","example":"Sample portal_json text content"},"portal_url":{"description":"Portal Url","type":"string","format":"uri","maxLength":100,"example":"example_portal_url"},"portal_username":{"description":"Portal Username","type":"string","maxLength":50,"example":"example_portal_username"},"portal_password":{"description":"Portal Password","type":"string","format":"password","maxLength":50,"example":"example_portal_password"},"email_credit_regex":{"description":"Email Credit Regex","type":"string","maxLength":500,"example":"example_email_credit_regex"},"trace":{"description":"Trace","type":"integer","maxLength":3,"minimum":0,"example":1},"credit":{"description":"Credit","type":"number","nullable":false,"maxLength":14,"default":"0","example":99.99},"debit_limit":{"description":"Debit Limit","type":"number","nullable":false,"maxLength":14,"default":"0","example":99.99},"tax":{"description":"Tax","type":"number","nullable":false,"maxLength":8,"default":"0","example":99.99},"snapshot_credit":{"description":"Snapshot Credit","type":"number","maxLength":8,"example":99.99},"snapshot_timestamp":{"description":"Snapshot Timestamp","type":"integer","maxLength":8,"minimum":0,"example":1000000},"currency":{"description":"Currency","type":"string","maxLength":3,"example":"USD"},"paypal":{"description":"Paypal","type":"string","maxLength":50,"example":"example_paypal"},"portal_access":{"description":"Portal Access","type":"string","maxLength":500,"default":"1","example":"example_portal_access"},"is_customer":{"description":"Is Customer","type":"integer","maxLength":3,"minimum":0,"default":"0","example":true},"is_carrier":{"description":"Is Carrier","type":"integer","maxLength":3,"minimum":0,"default":"0","example":true},"last_call":{"description":"Last Call","type":"integer","nullable":true,"maxLength":20,"minimum":0,"example":1000000},"auto_login_key":{"description":"Auto Login Key","type":"string","maxLength":50,"example":"example_auto_login_key"},"connexcs_permission":{"description":"Connexcs Permission","type":"string","maxLength":500,"example":"example_connexcs_permission"},"fr_timeout":{"description":"Fr Timeout","type":"integer","maxLength":3,"minimum":0,"default":"30","example":1},"pre_ring_timeout":{"description":"Pre Ring Timeout","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"30","example":1},"post_ring_timeout":{"description":"Post Ring Timeout","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"120","example":1},"p_asserted_identity":{"description":"P Asserted Identity","type":"string","enum":["default","remove","if-available","required"],"nullable":false,"default":"default","example":"default"},"reply_actions":{"description":"Reply Actions","type":"object","additionalProperties":true,"nullable":false,"maxLength":8000,"example":"example_reply_actions"},"reply_actions_json":{"description":"Reply Actions Json","type":"object","additionalProperties":true,"nullable":false,"maxLength":8000,"example":"example_reply_actions_json"},"did_api_id":{"description":"Did Api Id","type":"string","maxLength":50,"example":1},"account_api_id":{"description":"Account Api Id","type":"string","maxLength":50,"example":1},"resources_used":{"description":"Resources Used","type":"string","format":"binary","example":"base64-encoded-data"},"code_consistency":{"description":"Code Consistency","type":"number","maxLength":5,"minimum":0,"example":99.99},"code_consistency_points":{"description":"Code Consistency Points","type":"number","maxLength":5,"example":99.99},"min_payment":{"description":"Min Payment","type":"number","maxLength":8,"minimum":0,"example":99.99},"approved_cli_only":{"description":"Approved Cli Only","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"invoice_schedule":{"description":"Invoice Schedule","type":"string","enum":["day","week","bimonth","month","disabled"],"nullable":false,"default":"disabled","example":"day"},"invoice_due_days":{"description":"Invoice Due Days","type":"integer","maxLength":3,"minimum":0,"example":1},"propagate_username":{"description":"Propagate Username","type":"integer","maxLength":3,"minimum":0,"default":"0","example":1},"required":{"description":"Required","type":"array","items":{"type":"string","enum":["mobile_verification","email_verification"]},"nullable":false,"default":"","example":"mobile_verification"},"duration_latency_offset":{"description":"Duration Latency Offset","type":"number","maxLength":6,"example":99.99},"notes":{"description":"Notes","type":"string","example":"Sample notes text content"},"consec_backoff":{"description":"Consec Backoff","type":"integer","maxLength":255,"minimum":0,"default":"0","example":1},"tags":{"description":"Tags","type":"string","nullable":false,"maxLength":500,"example":"example_tags"},"vars":{"description":"Vars","type":"string","example":"Sample vars text content"},"topup_currencies":{"description":"Topup Currencies","type":"string","maxLength":255,"example":"example_topup_currencies"},"accounting_id":{"description":"Accounting Id","type":"string","maxLength":100,"example":1},"invoice_template":{"description":"Invoice Template","type":"string","maxLength":100,"example":"example_invoice_template"},"account_manager_id":{"description":"Account Manager Id","type":"integer","maxLength":10,"minimum":0,"example":1},"origid":{"description":"Origid","type":"string","maxLength":36,"default":"uuid()","example":"example_origid"},"rtp_firewall_warning":{"description":"Rtp Firewall Warning","type":"integer","maxLength":255,"minimum":0,"default":"0","example":1},"s3_size":{"description":"S 3 Size","type":"number","minimum":0,"example":1.5},"call_recording_retention_days":{"description":"Call Recording Retention Days","type":"integer","maxLength":10,"minimum":0,"default":"30","example":123},"range_holder_provider_card_id":{"description":"Range Holder Provider Card Id","type":"string","maxLength":10,"example":1},"domain_id":{"description":"Domain Id","type":"integer","maxLength":10,"minimum":0,"example":1},"cx_referal":{"description":"Cx Referal","type":"integer","nullable":false,"maxLength":3,"minimum":0,"example":1},"max_daily_spend":{"description":"Max Daily Spend","type":"number","maxLength":10,"example":99.99},"dt_restrict":{"description":"Dt Restrict","type":"object","additionalProperties":true,"maxLength":500,"example":"example_dt_restrict"},"default_stir_shaken_attestation":{"description":"Default Stir Shaken Attestation","type":"string","enum":["A","B","C"],"example":"A"},"flags":{"description":"Flags","type":"string","nullable":false,"maxLength":500,"example":"example_flags"}},"example":{"id":12345,"account_id":1,"reseller_id":1,"name":"Example Name","alias":"example_alias","channels":123,"cps":1.5,"system_id":1,"status":"Active","address1":"example_address1","address2":"example_address2","city":"example_city","county":10,"postcode":"example_postcode","website":"https://example.com","country":"US","credit_refresh_interval":123,"portal_json":"Sample portal_json text content","portal_url":"example_portal_url","portal_username":"example_portal_username","portal_password":"example_portal_password","email_credit_regex":"example_email_credit_regex","trace":1,"credit":99.99,"debit_limit":99.99,"tax":99.99,"snapshot_credit":99.99,"snapshot_timestamp":1000000,"currency":"USD","paypal":"example_paypal","portal_access":"example_portal_access","is_customer":true,"is_carrier":true,"last_call":1000000,"auto_login_key":"example_auto_login_key","connexcs_permission":"example_connexcs_permission","fr_timeout":1,"pre_ring_timeout":1,"post_ring_timeout":1,"p_asserted_identity":"default","reply_actions":"example_reply_actions","reply_actions_json":"example_reply_actions_json","did_api_id":1,"account_api_id":1,"resources_used":"base64-encoded-data","code_consistency":99.99,"code_consistency_points":99.99,"min_payment":99.99,"approved_cli_only":1,"invoice_schedule":"day","invoice_due_days":1,"propagate_username":1,"required":"mobile_verification","duration_latency_offset":99.99,"notes":"Sample notes text content","consec_backoff":1,"tags":"example_tags","vars":"Sample vars text content","topup_currencies":"example_topup_currencies","accounting_id":1,"invoice_template":"example_invoice_template","account_manager_id":1,"origid":"example_origid","rtp_firewall_warning":1,"s3_size":1.5,"call_recording_retention_days":123,"range_holder_provider_card_id":1,"domain_id":1,"cx_referal":1,"max_daily_spend":99.99,"dt_restrict":"example_dt_restrict","default_stir_shaken_attestation":"A","flags":"example_flags"},"required":["name","credit","debit_limit","tax","pre_ring_timeout","post_ring_timeout","p_asserted_identity","reply_actions","reply_actions_json","approved_cli_only","invoice_schedule","required","tags","cx_referal","flags"]},"circuitTestSchedule":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"provider_id":{"description":"Provider Id","type":"integer","maxLength":10,"minimum":0,"example":1},"card_id":{"description":"Card Id (references card.id)","type":"string","maxLength":255,"x-foreignKey":{"referencesTable":"card","referencesColumn":"id"},"example":1},"name":{"description":"Name","type":"string","maxLength":50,"example":"Example Name"},"schedule":{"description":"Schedule","type":"string","maxLength":100,"example":"example_schedule"},"cli":{"description":"Cli","type":"string","maxLength":50,"example":"example_cli"},"dest_number":{"description":"Dest Number","type":"string","maxLength":300,"example":"example_dest_number"},"interval":{"description":"Interval","type":"integer","maxLength":3,"minimum":0,"example":1}},"example":{"id":12345,"account_id":1,"provider_id":1,"card_id":1,"name":"Example Name","schedule":"example_schedule","cli":"example_cli","dest_number":"example_dest_number","interval":1}},"circuitTestScheduleInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"provider_id":{"description":"Provider Id","type":"integer","maxLength":10,"minimum":0,"example":1},"card_id":{"description":"Card Id (references card.id)","type":"string","maxLength":255,"x-foreignKey":{"referencesTable":"card","referencesColumn":"id"},"example":1},"name":{"description":"Name","type":"string","maxLength":50,"example":"Example Name"},"schedule":{"description":"Schedule","type":"string","maxLength":100,"example":"example_schedule"},"cli":{"description":"Cli","type":"string","maxLength":50,"example":"example_cli"},"dest_number":{"description":"Dest Number","type":"string","maxLength":300,"example":"example_dest_number"},"interval":{"description":"Interval","type":"integer","maxLength":3,"minimum":0,"example":1}},"example":{"id":12345,"account_id":1,"provider_id":1,"card_id":1,"name":"Example Name","schedule":"example_schedule","cli":"example_cli","dest_number":"example_dest_number","interval":1},"required":["name"]},"circuitTest":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"provider_id":{"description":"Provider Id","type":"integer","maxLength":10,"minimum":0,"example":1},"card_id":{"description":"Card Id","type":"string","maxLength":20,"example":1},"dt":{"description":"Dt","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"callid_a":{"description":"Callid A","type":"string","maxLength":255,"example":"example_callid_a"},"callid_b":{"description":"Callid B","type":"string","maxLength":255,"example":"example_callid_b"},"fas":{"description":"Fas","type":"integer","nullable":false,"maxLength":1,"minimum":0,"default":"0","example":1},"fas_type":{"description":"Fas Type","type":"string","maxLength":255,"example":"example_fas_type"},"dest_number":{"description":"Dest Number","type":"string","maxLength":255,"example":"example_dest_number"},"in_mos":{"description":"In Mos","type":"number","maxLength":8,"example":1.5},"in_dtmf":{"description":"In Dtmf","type":"string","maxLength":20,"example":"example_in_dtmf"},"in_cli":{"description":"In Cli","type":"string","maxLength":20,"example":"example_in_cli"},"in_codec":{"description":"In Codec","type":"string","maxLength":20,"example":"example_in_codec"},"in_audio_engagement_delay":{"description":"In Audio Engagement Delay","type":"number","example":1.5},"out_mos":{"description":"Out Mos","type":"number","maxLength":8,"example":1.5},"out_dtmf":{"description":"Out Dtmf","type":"string","maxLength":20,"example":"example_out_dtmf"},"out_cli":{"description":"Out Cli","type":"string","maxLength":20,"example":"example_out_cli"},"out_codec":{"description":"Out Codec","type":"string","maxLength":20,"example":"example_out_codec"},"out_audio_engagement_delay":{"description":"Out Audio Engagement Delay","type":"number","example":1.5},"cli":{"description":"Cli","type":"number","maxLength":8,"example":1.5},"mos":{"description":"Mos","type":"number","maxLength":8,"example":1.5},"delay100":{"description":"Delay 100","type":"number","example":1.5},"delay180":{"description":"Delay 180","type":"number","example":1.5},"delay183":{"description":"Delay 183","type":"number","example":1.5},"delay_audio":{"description":"Delay Audio","type":"number","example":1.5},"codec":{"description":"Codec","type":"string","maxLength":20,"example":"example_codec"},"release":{"description":"Release","type":"string","maxLength":20,"example":"example_release"},"release_status":{"description":"Release Status","type":"string","maxLength":20,"example":"example_release_status"},"answer_diff":{"description":"Answer Diff","type":"integer","maxLength":10,"example":123},"release_diff":{"description":"Release Diff","type":"integer","maxLength":10,"example":123}},"example":{"id":12345,"account_id":1,"provider_id":1,"card_id":1,"dt":"2025-01-17T10:30:00Z","callid_a":"example_callid_a","callid_b":"example_callid_b","fas":1,"fas_type":"example_fas_type","dest_number":"example_dest_number","in_mos":1.5,"in_dtmf":"example_in_dtmf","in_cli":"example_in_cli","in_codec":"example_in_codec","in_audio_engagement_delay":1.5,"out_mos":1.5,"out_dtmf":"example_out_dtmf","out_cli":"example_out_cli","out_codec":"example_out_codec","out_audio_engagement_delay":1.5,"cli":1.5,"mos":1.5,"delay100":1.5,"delay180":1.5,"delay183":1.5,"delay_audio":1.5,"codec":"example_codec","release":"example_release","release_status":"example_release_status","answer_diff":123,"release_diff":123}},"circuitTestInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"provider_id":{"description":"Provider Id","type":"integer","maxLength":10,"minimum":0,"example":1},"card_id":{"description":"Card Id","type":"string","maxLength":20,"example":1},"dt":{"description":"Dt","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"callid_a":{"description":"Callid A","type":"string","maxLength":255,"example":"example_callid_a"},"callid_b":{"description":"Callid B","type":"string","maxLength":255,"example":"example_callid_b"},"fas":{"description":"Fas","type":"integer","nullable":false,"maxLength":1,"minimum":0,"default":"0","example":1},"fas_type":{"description":"Fas Type","type":"string","maxLength":255,"example":"example_fas_type"},"dest_number":{"description":"Dest Number","type":"string","maxLength":255,"example":"example_dest_number"},"in_mos":{"description":"In Mos","type":"number","maxLength":8,"example":1.5},"in_dtmf":{"description":"In Dtmf","type":"string","maxLength":20,"example":"example_in_dtmf"},"in_cli":{"description":"In Cli","type":"string","maxLength":20,"example":"example_in_cli"},"in_codec":{"description":"In Codec","type":"string","maxLength":20,"example":"example_in_codec"},"in_audio_engagement_delay":{"description":"In Audio Engagement Delay","type":"number","example":1.5},"out_mos":{"description":"Out Mos","type":"number","maxLength":8,"example":1.5},"out_dtmf":{"description":"Out Dtmf","type":"string","maxLength":20,"example":"example_out_dtmf"},"out_cli":{"description":"Out Cli","type":"string","maxLength":20,"example":"example_out_cli"},"out_codec":{"description":"Out Codec","type":"string","maxLength":20,"example":"example_out_codec"},"out_audio_engagement_delay":{"description":"Out Audio Engagement Delay","type":"number","example":1.5},"cli":{"description":"Cli","type":"number","maxLength":8,"example":1.5},"mos":{"description":"Mos","type":"number","maxLength":8,"example":1.5},"delay100":{"description":"Delay 100","type":"number","example":1.5},"delay180":{"description":"Delay 180","type":"number","example":1.5},"delay183":{"description":"Delay 183","type":"number","example":1.5},"delay_audio":{"description":"Delay Audio","type":"number","example":1.5},"codec":{"description":"Codec","type":"string","maxLength":20,"example":"example_codec"},"release":{"description":"Release","type":"string","maxLength":20,"example":"example_release"},"release_status":{"description":"Release Status","type":"string","maxLength":20,"example":"example_release_status"},"answer_diff":{"description":"Answer Diff","type":"integer","maxLength":10,"example":123},"release_diff":{"description":"Release Diff","type":"integer","maxLength":10,"example":123}},"example":{"id":12345,"account_id":1,"provider_id":1,"card_id":1,"dt":"2025-01-17T10:30:00Z","callid_a":"example_callid_a","callid_b":"example_callid_b","fas":1,"fas_type":"example_fas_type","dest_number":"example_dest_number","in_mos":1.5,"in_dtmf":"example_in_dtmf","in_cli":"example_in_cli","in_codec":"example_in_codec","in_audio_engagement_delay":1.5,"out_mos":1.5,"out_dtmf":"example_out_dtmf","out_cli":"example_out_cli","out_codec":"example_out_codec","out_audio_engagement_delay":1.5,"cli":1.5,"mos":1.5,"delay100":1.5,"delay180":1.5,"delay183":1.5,"delay_audio":1.5,"codec":"example_codec","release":"example_release","release_status":"example_release_status","answer_diff":123,"release_diff":123},"required":["fas"]},"cliGlobal":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"cli":{"description":"Cli","type":"string","maxLength":500,"example":"example_cli"},"cli_rewrite":{"description":"Cli Rewrite","type":"string","maxLength":50,"example":"example_cli_rewrite"},"p_asserted_identity_rewrite":{"description":"P Asserted Identity Rewrite","type":"string","maxLength":50,"example":"example_p_asserted_identity_rewrite"},"forced":{"description":"Forced","type":"integer","maxLength":3,"minimum":0,"default":"0","example":1},"p_asserted_identity":{"description":"P Asserted Identity","type":"string","maxLength":50,"example":"example_p_asserted_identity"},"notes":{"description":"Notes","type":"string","maxLength":1000,"example":"example_notes"},"origination":{"description":"Origination","type":"integer","maxLength":1,"minimum":0,"default":"0","example":1},"use_did":{"description":"Use Did","type":"string","enum":["Disabled","Filter","Random","Prefix Match","Performance"],"nullable":false,"default":"Disabled","example":"Disabled"},"stir_shaken_cert_id":{"description":"Stir Shaken Cert Id","type":"string","maxLength":32,"example":1},"stir_shaken_attestation":{"description":"Stir Shaken Attestation","type":"string","enum":["None","A","B","C"],"nullable":false,"default":"None","example":"None"},"dn_match":{"description":"Dn Match","type":"string","maxLength":500,"example":"example_dn_match"},"datastore_id":{"description":"Datastore Id","type":"string","maxLength":100,"example":1},"allow_type":{"description":"Allow Type","type":"string","maxLength":255,"example":"example_allow_type"},"ftc_reported":{"description":"Ftc Reported","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"tag":{"description":"Tag","type":"string","maxLength":255,"example":"example_tag"},"flags":{"description":"Flags","type":"string","maxLength":255,"example":"example_flags"},"performance_top_batch_size":{"description":"Performance Top Batch Size","type":"integer","maxLength":5,"minimum":0,"example":100},"performance_interval":{"description":"Performance Interval","type":"integer","maxLength":8,"minimum":0,"example":1000},"performance_ban_time":{"description":"Performance Ban Time","type":"integer","maxLength":8,"minimum":0,"example":1000},"hit_limit":{"description":"Hit Limit","type":"integer","maxLength":10,"minimum":0,"example":123},"hit_interval":{"description":"Hit Interval","type":"integer","maxLength":10,"minimum":0,"example":1000}},"example":{"id":12345,"account_id":1,"cli":"example_cli","cli_rewrite":"example_cli_rewrite","p_asserted_identity_rewrite":"example_p_asserted_identity_rewrite","forced":1,"p_asserted_identity":"example_p_asserted_identity","notes":"example_notes","origination":1,"use_did":"Disabled","stir_shaken_cert_id":1,"stir_shaken_attestation":"None","dn_match":"example_dn_match","datastore_id":1,"allow_type":"example_allow_type","ftc_reported":1,"tag":"example_tag","flags":"example_flags","performance_top_batch_size":100,"performance_interval":1000,"performance_ban_time":1000,"hit_limit":123,"hit_interval":1000}},"cliGlobalInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"cli":{"description":"Cli","type":"string","maxLength":500,"example":"example_cli"},"cli_rewrite":{"description":"Cli Rewrite","type":"string","maxLength":50,"example":"example_cli_rewrite"},"p_asserted_identity_rewrite":{"description":"P Asserted Identity Rewrite","type":"string","maxLength":50,"example":"example_p_asserted_identity_rewrite"},"forced":{"description":"Forced","type":"integer","maxLength":3,"minimum":0,"default":"0","example":1},"p_asserted_identity":{"description":"P Asserted Identity","type":"string","maxLength":50,"example":"example_p_asserted_identity"},"notes":{"description":"Notes","type":"string","maxLength":1000,"example":"example_notes"},"origination":{"description":"Origination","type":"integer","maxLength":1,"minimum":0,"default":"0","example":1},"use_did":{"description":"Use Did","type":"string","enum":["Disabled","Filter","Random","Prefix Match","Performance"],"nullable":false,"default":"Disabled","example":"Disabled"},"stir_shaken_cert_id":{"description":"Stir Shaken Cert Id","type":"string","maxLength":32,"example":1},"stir_shaken_attestation":{"description":"Stir Shaken Attestation","type":"string","enum":["None","A","B","C"],"nullable":false,"default":"None","example":"None"},"dn_match":{"description":"Dn Match","type":"string","maxLength":500,"example":"example_dn_match"},"datastore_id":{"description":"Datastore Id","type":"string","maxLength":100,"example":1},"allow_type":{"description":"Allow Type","type":"string","maxLength":255,"example":"example_allow_type"},"ftc_reported":{"description":"Ftc Reported","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"tag":{"description":"Tag","type":"string","maxLength":255,"example":"example_tag"},"flags":{"description":"Flags","type":"string","maxLength":255,"example":"example_flags"},"performance_top_batch_size":{"description":"Performance Top Batch Size","type":"integer","maxLength":5,"minimum":0,"example":100},"performance_interval":{"description":"Performance Interval","type":"integer","maxLength":8,"minimum":0,"example":1000},"performance_ban_time":{"description":"Performance Ban Time","type":"integer","maxLength":8,"minimum":0,"example":1000},"hit_limit":{"description":"Hit Limit","type":"integer","maxLength":10,"minimum":0,"example":123},"hit_interval":{"description":"Hit Interval","type":"integer","maxLength":10,"minimum":0,"example":1000}},"example":{"id":12345,"account_id":1,"cli":"example_cli","cli_rewrite":"example_cli_rewrite","p_asserted_identity_rewrite":"example_p_asserted_identity_rewrite","forced":1,"p_asserted_identity":"example_p_asserted_identity","notes":"example_notes","origination":1,"use_did":"Disabled","stir_shaken_cert_id":1,"stir_shaken_attestation":"None","dn_match":"example_dn_match","datastore_id":1,"allow_type":"example_allow_type","ftc_reported":1,"tag":"example_tag","flags":"example_flags","performance_top_batch_size":100,"performance_interval":1000,"performance_ban_time":1000,"hit_limit":123,"hit_interval":1000},"required":["use_did","stir_shaken_attestation","ftc_reported"]},"customer":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"reseller_id":{"description":"Reseller Id","type":"integer","maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":100,"example":"Example Name"},"alias":{"description":"Alias","type":"string","maxLength":50,"example":"example_alias"},"channels":{"description":"Channels","type":"integer","maxLength":10,"minimum":0,"example":123},"cps":{"description":"Cps","type":"number","example":1.5},"system_id":{"description":"System Id","type":"string","maxLength":50,"example":1},"status":{"description":"Status","type":"string","maxLength":50,"default":"Active","example":"Active"},"address1":{"description":"Address 1","type":"string","maxLength":200,"example":"example_address1"},"address2":{"description":"Address 2","type":"string","maxLength":200,"example":"example_address2"},"city":{"description":"City","type":"string","maxLength":100,"example":"example_city"},"county":{"description":"County","type":"string","maxLength":200,"example":10},"postcode":{"description":"Postcode","type":"string","maxLength":10,"example":"example_postcode"},"website":{"description":"Website","type":"string","format":"uri","maxLength":100,"example":"https://example.com"},"country":{"description":"Country","type":"string","maxLength":100,"example":"US"},"credit_refresh_interval":{"description":"Credit Refresh Interval","type":"integer","maxLength":8,"minimum":0,"example":123},"portal_json":{"description":"Portal Json","type":"string","example":"Sample portal_json text content"},"portal_url":{"description":"Portal Url","type":"string","format":"uri","maxLength":100,"example":"example_portal_url"},"portal_username":{"description":"Portal Username","type":"string","maxLength":50,"example":"example_portal_username"},"portal_password":{"description":"Portal Password","type":"string","format":"password","maxLength":50,"example":"example_portal_password"},"email_credit_regex":{"description":"Email Credit Regex","type":"string","maxLength":500,"example":"example_email_credit_regex"},"trace":{"description":"Trace","type":"integer","maxLength":3,"minimum":0,"example":1},"credit":{"description":"Credit","type":"number","nullable":false,"maxLength":14,"default":"0","example":99.99},"debit_limit":{"description":"Debit Limit","type":"number","nullable":false,"maxLength":14,"default":"0","example":99.99},"tax":{"description":"Tax","type":"number","nullable":false,"maxLength":8,"default":"0","example":99.99},"snapshot_credit":{"description":"Snapshot Credit","type":"number","maxLength":8,"example":99.99},"snapshot_timestamp":{"description":"Snapshot Timestamp","type":"integer","maxLength":8,"minimum":0,"example":1000000},"currency":{"description":"Currency","type":"string","maxLength":3,"example":"USD"},"paypal":{"description":"Paypal","type":"string","maxLength":50,"example":"example_paypal"},"portal_access":{"description":"Portal Access","type":"string","maxLength":500,"default":"1","example":"example_portal_access"},"is_customer":{"description":"Is Customer","type":"integer","maxLength":3,"minimum":0,"default":"0","example":true},"is_carrier":{"description":"Is Carrier","type":"integer","maxLength":3,"minimum":0,"default":"0","example":true},"last_call":{"description":"Last Call","type":"integer","nullable":true,"maxLength":20,"minimum":0,"example":1000000},"auto_login_key":{"description":"Auto Login Key","type":"string","maxLength":50,"example":"example_auto_login_key"},"connexcs_permission":{"description":"Connexcs Permission","type":"string","maxLength":500,"example":"example_connexcs_permission"},"fr_timeout":{"description":"Fr Timeout","type":"integer","maxLength":3,"minimum":0,"default":"30","example":1},"pre_ring_timeout":{"description":"Pre Ring Timeout","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"30","example":1},"post_ring_timeout":{"description":"Post Ring Timeout","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"120","example":1},"p_asserted_identity":{"description":"P Asserted Identity","type":"string","enum":["default","remove","if-available","required"],"nullable":false,"default":"default","example":"default"},"reply_actions":{"description":"Reply Actions","type":"object","additionalProperties":true,"nullable":false,"maxLength":8000,"example":"example_reply_actions"},"reply_actions_json":{"description":"Reply Actions Json","type":"object","additionalProperties":true,"nullable":false,"maxLength":8000,"example":"example_reply_actions_json"},"did_api_id":{"description":"Did Api Id","type":"string","maxLength":50,"example":1},"account_api_id":{"description":"Account Api Id","type":"string","maxLength":50,"example":1},"resources_used":{"description":"Resources Used","type":"string","format":"binary","example":"base64-encoded-data"},"code_consistency":{"description":"Code Consistency","type":"number","maxLength":5,"minimum":0,"example":99.99},"code_consistency_points":{"description":"Code Consistency Points","type":"number","maxLength":5,"example":99.99},"min_payment":{"description":"Min Payment","type":"number","maxLength":8,"minimum":0,"example":99.99},"approved_cli_only":{"description":"Approved Cli Only","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"invoice_schedule":{"description":"Invoice Schedule","type":"string","enum":["day","week","bimonth","month","disabled"],"nullable":false,"default":"disabled","example":"day"},"invoice_due_days":{"description":"Invoice Due Days","type":"integer","maxLength":3,"minimum":0,"example":1},"propagate_username":{"description":"Propagate Username","type":"integer","maxLength":3,"minimum":0,"default":"0","example":1},"required":{"description":"Required","type":"array","items":{"type":"string","enum":["mobile_verification","email_verification"]},"nullable":false,"default":"","example":"mobile_verification"},"duration_latency_offset":{"description":"Duration Latency Offset","type":"number","maxLength":6,"example":99.99},"notes":{"description":"Notes","type":"string","example":"Sample notes text content"},"consec_backoff":{"description":"Consec Backoff","type":"integer","maxLength":255,"minimum":0,"default":"0","example":1},"tags":{"description":"Tags","type":"string","nullable":false,"maxLength":500,"example":"example_tags"},"vars":{"description":"Vars","type":"string","example":"Sample vars text content"},"topup_currencies":{"description":"Topup Currencies","type":"string","maxLength":255,"example":"example_topup_currencies"},"accounting_id":{"description":"Accounting Id","type":"string","maxLength":100,"example":1},"invoice_template":{"description":"Invoice Template","type":"string","maxLength":100,"example":"example_invoice_template"},"account_manager_id":{"description":"Account Manager Id","type":"integer","maxLength":10,"minimum":0,"example":1},"origid":{"description":"Origid","type":"string","maxLength":36,"default":"uuid()","example":"example_origid"},"rtp_firewall_warning":{"description":"Rtp Firewall Warning","type":"integer","maxLength":255,"minimum":0,"default":"0","example":1},"s3_size":{"description":"S 3 Size","type":"number","minimum":0,"example":1.5},"call_recording_retention_days":{"description":"Call Recording Retention Days","type":"integer","maxLength":10,"minimum":0,"default":"30","example":123},"range_holder_provider_card_id":{"description":"Range Holder Provider Card Id","type":"string","maxLength":10,"example":1},"domain_id":{"description":"Domain Id","type":"integer","maxLength":10,"minimum":0,"example":1},"cx_referal":{"description":"Cx Referal","type":"integer","nullable":false,"maxLength":3,"minimum":0,"example":1},"max_daily_spend":{"description":"Max Daily Spend","type":"number","maxLength":10,"example":99.99},"dt_restrict":{"description":"Dt Restrict","type":"object","additionalProperties":true,"maxLength":500,"example":"example_dt_restrict"},"default_stir_shaken_attestation":{"description":"Default Stir Shaken Attestation","type":"string","enum":["A","B","C"],"example":"A"},"flags":{"description":"Flags","type":"string","nullable":false,"maxLength":500,"example":"example_flags"}},"example":{"id":12345,"account_id":1,"reseller_id":1,"name":"Example Name","alias":"example_alias","channels":123,"cps":1.5,"system_id":1,"status":"Active","address1":"example_address1","address2":"example_address2","city":"example_city","county":10,"postcode":"example_postcode","website":"https://example.com","country":"US","credit_refresh_interval":123,"portal_json":"Sample portal_json text content","portal_url":"example_portal_url","portal_username":"example_portal_username","portal_password":"example_portal_password","email_credit_regex":"example_email_credit_regex","trace":1,"credit":99.99,"debit_limit":99.99,"tax":99.99,"snapshot_credit":99.99,"snapshot_timestamp":1000000,"currency":"USD","paypal":"example_paypal","portal_access":"example_portal_access","is_customer":true,"is_carrier":true,"last_call":1000000,"auto_login_key":"example_auto_login_key","connexcs_permission":"example_connexcs_permission","fr_timeout":1,"pre_ring_timeout":1,"post_ring_timeout":1,"p_asserted_identity":"default","reply_actions":"example_reply_actions","reply_actions_json":"example_reply_actions_json","did_api_id":1,"account_api_id":1,"resources_used":"base64-encoded-data","code_consistency":99.99,"code_consistency_points":99.99,"min_payment":99.99,"approved_cli_only":1,"invoice_schedule":"day","invoice_due_days":1,"propagate_username":1,"required":"mobile_verification","duration_latency_offset":99.99,"notes":"Sample notes text content","consec_backoff":1,"tags":"example_tags","vars":"Sample vars text content","topup_currencies":"example_topup_currencies","accounting_id":1,"invoice_template":"example_invoice_template","account_manager_id":1,"origid":"example_origid","rtp_firewall_warning":1,"s3_size":1.5,"call_recording_retention_days":123,"range_holder_provider_card_id":1,"domain_id":1,"cx_referal":1,"max_daily_spend":99.99,"dt_restrict":"example_dt_restrict","default_stir_shaken_attestation":"A","flags":"example_flags"}},"customerInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"reseller_id":{"description":"Reseller Id","type":"integer","maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":100,"example":"Example Name"},"alias":{"description":"Alias","type":"string","maxLength":50,"example":"example_alias"},"channels":{"description":"Channels","type":"integer","maxLength":10,"minimum":0,"example":123},"cps":{"description":"Cps","type":"number","example":1.5},"system_id":{"description":"System Id","type":"string","maxLength":50,"example":1},"status":{"description":"Status","type":"string","maxLength":50,"default":"Active","example":"Active"},"address1":{"description":"Address 1","type":"string","maxLength":200,"example":"example_address1"},"address2":{"description":"Address 2","type":"string","maxLength":200,"example":"example_address2"},"city":{"description":"City","type":"string","maxLength":100,"example":"example_city"},"county":{"description":"County","type":"string","maxLength":200,"example":10},"postcode":{"description":"Postcode","type":"string","maxLength":10,"example":"example_postcode"},"website":{"description":"Website","type":"string","format":"uri","maxLength":100,"example":"https://example.com"},"country":{"description":"Country","type":"string","maxLength":100,"example":"US"},"credit_refresh_interval":{"description":"Credit Refresh Interval","type":"integer","maxLength":8,"minimum":0,"example":123},"portal_json":{"description":"Portal Json","type":"string","example":"Sample portal_json text content"},"portal_url":{"description":"Portal Url","type":"string","format":"uri","maxLength":100,"example":"example_portal_url"},"portal_username":{"description":"Portal Username","type":"string","maxLength":50,"example":"example_portal_username"},"portal_password":{"description":"Portal Password","type":"string","format":"password","maxLength":50,"example":"example_portal_password"},"email_credit_regex":{"description":"Email Credit Regex","type":"string","maxLength":500,"example":"example_email_credit_regex"},"trace":{"description":"Trace","type":"integer","maxLength":3,"minimum":0,"example":1},"credit":{"description":"Credit","type":"number","nullable":false,"maxLength":14,"default":"0","example":99.99},"debit_limit":{"description":"Debit Limit","type":"number","nullable":false,"maxLength":14,"default":"0","example":99.99},"tax":{"description":"Tax","type":"number","nullable":false,"maxLength":8,"default":"0","example":99.99},"snapshot_credit":{"description":"Snapshot Credit","type":"number","maxLength":8,"example":99.99},"snapshot_timestamp":{"description":"Snapshot Timestamp","type":"integer","maxLength":8,"minimum":0,"example":1000000},"currency":{"description":"Currency","type":"string","maxLength":3,"example":"USD"},"paypal":{"description":"Paypal","type":"string","maxLength":50,"example":"example_paypal"},"portal_access":{"description":"Portal Access","type":"string","maxLength":500,"default":"1","example":"example_portal_access"},"is_customer":{"description":"Is Customer","type":"integer","maxLength":3,"minimum":0,"default":"0","example":true},"is_carrier":{"description":"Is Carrier","type":"integer","maxLength":3,"minimum":0,"default":"0","example":true},"last_call":{"description":"Last Call","type":"integer","nullable":true,"maxLength":20,"minimum":0,"example":1000000},"auto_login_key":{"description":"Auto Login Key","type":"string","maxLength":50,"example":"example_auto_login_key"},"connexcs_permission":{"description":"Connexcs Permission","type":"string","maxLength":500,"example":"example_connexcs_permission"},"fr_timeout":{"description":"Fr Timeout","type":"integer","maxLength":3,"minimum":0,"default":"30","example":1},"pre_ring_timeout":{"description":"Pre Ring Timeout","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"30","example":1},"post_ring_timeout":{"description":"Post Ring Timeout","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"120","example":1},"p_asserted_identity":{"description":"P Asserted Identity","type":"string","enum":["default","remove","if-available","required"],"nullable":false,"default":"default","example":"default"},"reply_actions":{"description":"Reply Actions","type":"object","additionalProperties":true,"nullable":false,"maxLength":8000,"example":"example_reply_actions"},"reply_actions_json":{"description":"Reply Actions Json","type":"object","additionalProperties":true,"nullable":false,"maxLength":8000,"example":"example_reply_actions_json"},"did_api_id":{"description":"Did Api Id","type":"string","maxLength":50,"example":1},"account_api_id":{"description":"Account Api Id","type":"string","maxLength":50,"example":1},"resources_used":{"description":"Resources Used","type":"string","format":"binary","example":"base64-encoded-data"},"code_consistency":{"description":"Code Consistency","type":"number","maxLength":5,"minimum":0,"example":99.99},"code_consistency_points":{"description":"Code Consistency Points","type":"number","maxLength":5,"example":99.99},"min_payment":{"description":"Min Payment","type":"number","maxLength":8,"minimum":0,"example":99.99},"approved_cli_only":{"description":"Approved Cli Only","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"invoice_schedule":{"description":"Invoice Schedule","type":"string","enum":["day","week","bimonth","month","disabled"],"nullable":false,"default":"disabled","example":"day"},"invoice_due_days":{"description":"Invoice Due Days","type":"integer","maxLength":3,"minimum":0,"example":1},"propagate_username":{"description":"Propagate Username","type":"integer","maxLength":3,"minimum":0,"default":"0","example":1},"required":{"description":"Required","type":"array","items":{"type":"string","enum":["mobile_verification","email_verification"]},"nullable":false,"default":"","example":"mobile_verification"},"duration_latency_offset":{"description":"Duration Latency Offset","type":"number","maxLength":6,"example":99.99},"notes":{"description":"Notes","type":"string","example":"Sample notes text content"},"consec_backoff":{"description":"Consec Backoff","type":"integer","maxLength":255,"minimum":0,"default":"0","example":1},"tags":{"description":"Tags","type":"string","nullable":false,"maxLength":500,"example":"example_tags"},"vars":{"description":"Vars","type":"string","example":"Sample vars text content"},"topup_currencies":{"description":"Topup Currencies","type":"string","maxLength":255,"example":"example_topup_currencies"},"accounting_id":{"description":"Accounting Id","type":"string","maxLength":100,"example":1},"invoice_template":{"description":"Invoice Template","type":"string","maxLength":100,"example":"example_invoice_template"},"account_manager_id":{"description":"Account Manager Id","type":"integer","maxLength":10,"minimum":0,"example":1},"origid":{"description":"Origid","type":"string","maxLength":36,"default":"uuid()","example":"example_origid"},"rtp_firewall_warning":{"description":"Rtp Firewall Warning","type":"integer","maxLength":255,"minimum":0,"default":"0","example":1},"s3_size":{"description":"S 3 Size","type":"number","minimum":0,"example":1.5},"call_recording_retention_days":{"description":"Call Recording Retention Days","type":"integer","maxLength":10,"minimum":0,"default":"30","example":123},"range_holder_provider_card_id":{"description":"Range Holder Provider Card Id","type":"string","maxLength":10,"example":1},"domain_id":{"description":"Domain Id","type":"integer","maxLength":10,"minimum":0,"example":1},"cx_referal":{"description":"Cx Referal","type":"integer","nullable":false,"maxLength":3,"minimum":0,"example":1},"max_daily_spend":{"description":"Max Daily Spend","type":"number","maxLength":10,"example":99.99},"dt_restrict":{"description":"Dt Restrict","type":"object","additionalProperties":true,"maxLength":500,"example":"example_dt_restrict"},"default_stir_shaken_attestation":{"description":"Default Stir Shaken Attestation","type":"string","enum":["A","B","C"],"example":"A"},"flags":{"description":"Flags","type":"string","nullable":false,"maxLength":500,"example":"example_flags"}},"example":{"id":12345,"account_id":1,"reseller_id":1,"name":"Example Name","alias":"example_alias","channels":123,"cps":1.5,"system_id":1,"status":"Active","address1":"example_address1","address2":"example_address2","city":"example_city","county":10,"postcode":"example_postcode","website":"https://example.com","country":"US","credit_refresh_interval":123,"portal_json":"Sample portal_json text content","portal_url":"example_portal_url","portal_username":"example_portal_username","portal_password":"example_portal_password","email_credit_regex":"example_email_credit_regex","trace":1,"credit":99.99,"debit_limit":99.99,"tax":99.99,"snapshot_credit":99.99,"snapshot_timestamp":1000000,"currency":"USD","paypal":"example_paypal","portal_access":"example_portal_access","is_customer":true,"is_carrier":true,"last_call":1000000,"auto_login_key":"example_auto_login_key","connexcs_permission":"example_connexcs_permission","fr_timeout":1,"pre_ring_timeout":1,"post_ring_timeout":1,"p_asserted_identity":"default","reply_actions":"example_reply_actions","reply_actions_json":"example_reply_actions_json","did_api_id":1,"account_api_id":1,"resources_used":"base64-encoded-data","code_consistency":99.99,"code_consistency_points":99.99,"min_payment":99.99,"approved_cli_only":1,"invoice_schedule":"day","invoice_due_days":1,"propagate_username":1,"required":"mobile_verification","duration_latency_offset":99.99,"notes":"Sample notes text content","consec_backoff":1,"tags":"example_tags","vars":"Sample vars text content","topup_currencies":"example_topup_currencies","accounting_id":1,"invoice_template":"example_invoice_template","account_manager_id":1,"origid":"example_origid","rtp_firewall_warning":1,"s3_size":1.5,"call_recording_retention_days":123,"range_holder_provider_card_id":1,"domain_id":1,"cx_referal":1,"max_daily_spend":99.99,"dt_restrict":"example_dt_restrict","default_stir_shaken_attestation":"A","flags":"example_flags"},"required":["name","credit","debit_limit","tax","pre_ring_timeout","post_ring_timeout","p_asserted_identity","reply_actions","reply_actions_json","approved_cli_only","invoice_schedule","required","tags","cx_referal","flags"]},"cxPackage":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"key":{"description":"Key","type":"string","maxLength":50,"example":"example_key"},"name":{"description":"Name","type":"string","nullable":false,"maxLength":255,"example":"Example Name"},"cost":{"description":"Cost","type":"number","nullable":false,"maxLength":12,"example":99.99},"qty_units":{"description":"Qty Units","type":"string","maxLength":50,"example":"example_qty_units"},"flag":{"description":"Flag","type":"array","items":{"type":"string","enum":["MRC","BILL_UNITS","PUBLIC","SELF_SUBSCRIBE","ADJUST_DAILY_LIMIT"]},"default":"","example":"MRC"},"description":{"description":"Description","type":"string","example":"A detailed description of the resource"},"icon":{"description":"Icon","type":"string","maxLength":30,"example":"example_icon"}},"example":{"id":12345,"key":"example_key","name":"Example Name","cost":99.99,"qty_units":"example_qty_units","flag":"MRC","description":"A detailed description of the resource","icon":"example_icon"}},"setupVoucher":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":255,"minimum":0,"example":12345},"code":{"description":"Code","type":"string","nullable":false,"maxLength":255,"example":"example_code"},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"end_date":{"description":"End Date","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"state":{"description":"State","type":"string","enum":["Active","Inactive","Used"],"nullable":false,"default":"Active","example":"Active"},"description":{"description":"Description","type":"string","nullable":false,"maxLength":500,"example":"A detailed description of the resource"},"min_activation":{"description":"Min Activation","type":"number","maxLength":6,"example":99.99},"multiplier":{"description":"Multiplier","type":"number","maxLength":6,"example":99.99},"addition":{"description":"Addition","type":"number","maxLength":6,"example":99.99},"used_by_account_id":{"description":"Used By Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"use_once":{"description":"Use Once","type":"integer","maxLength":3,"minimum":0,"example":1},"min_per_minute_rate":{"description":"Min Per Minute Rate","type":"number","maxLength":10,"default":"0","example":99.99}},"example":{"id":12345,"code":"example_code","account_id":1,"end_date":"2025-01-17T10:30:00Z","state":"Active","description":"A detailed description of the resource","min_activation":99.99,"multiplier":99.99,"addition":99.99,"used_by_account_id":1,"use_once":1,"min_per_minute_rate":99.99}},"setupVoucherInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":255,"minimum":0,"example":12345},"code":{"description":"Code","type":"string","nullable":false,"maxLength":255,"example":"example_code"},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"end_date":{"description":"End Date","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"state":{"description":"State","type":"string","enum":["Active","Inactive","Used"],"nullable":false,"default":"Active","example":"Active"},"description":{"description":"Description","type":"string","nullable":false,"maxLength":500,"example":"A detailed description of the resource"},"min_activation":{"description":"Min Activation","type":"number","maxLength":6,"example":99.99},"multiplier":{"description":"Multiplier","type":"number","maxLength":6,"example":99.99},"addition":{"description":"Addition","type":"number","maxLength":6,"example":99.99},"used_by_account_id":{"description":"Used By Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"use_once":{"description":"Use Once","type":"integer","maxLength":3,"minimum":0,"example":1},"min_per_minute_rate":{"description":"Min Per Minute Rate","type":"number","maxLength":10,"default":"0","example":99.99}},"example":{"id":12345,"code":"example_code","account_id":1,"end_date":"2025-01-17T10:30:00Z","state":"Active","description":"A detailed description of the resource","min_activation":99.99,"multiplier":99.99,"addition":99.99,"used_by_account_id":1,"use_once":1,"min_per_minute_rate":99.99},"required":["code","state","description"]},"did":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"customer_id":{"description":"Customer Id (references company.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"company","referencesColumn":"id"},"example":1},"provider_id":{"description":"Provider Id (references company.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"company","referencesColumn":"id"},"example":1},"did":{"description":"Did","type":"string","maxLength":30,"default":"","example":"example_did"},"provider_card_id":{"description":"Provider Card Id","type":"string","maxLength":10,"example":1},"customer_card_id":{"description":"Customer Card Id","type":"string","maxLength":10,"example":1},"destination":{"description":"Destination","type":"string","nullable":false,"maxLength":100,"default":"","example":"example_destination"},"destination_type":{"description":"Destination Type","type":"string","maxLength":30,"example":"example_destination_type"},"destination2":{"description":"Destination 2","type":"string","maxLength":100,"example":"example_destination2"},"destination2_type":{"description":"Destination 2 Type","type":"string","maxLength":30,"example":"example_destination2_type"},"destination3":{"description":"Destination 3","type":"string","maxLength":100,"example":"example_destination3"},"destination3_type":{"description":"Destination 3 Type","type":"string","maxLength":30,"example":"example_destination3_type"},"notes":{"description":"Notes","type":"string","example":"Sample notes text content"},"channels":{"description":"Channels","type":"integer","maxLength":255,"minimum":0,"example":123},"cps":{"description":"Cps","type":"integer","maxLength":255,"minimum":0,"example":123},"max_duration":{"description":"Max Duration","type":"integer","maxLength":11,"default":"3600","example":123},"rtp_proxy":{"description":"Rtp Proxy","type":"integer","nullable":false,"maxLength":50,"minimum":0,"default":"101","example":1},"rtp_mode":{"description":"Rtp Mode","type":"string","enum":["Relaxed","Strict"],"default":"Strict","example":"Relaxed"},"timeout":{"description":"Timeout","type":"array","items":{"type":"string","enum":["SIP Ping","RTP Proxy"]},"example":"SIP Ping"},"cost":{"description":"Cost","type":"number","maxLength":10,"example":99.99},"retail":{"description":"Retail","type":"number","maxLength":10,"example":99.99},"start_date":{"description":"Start Date","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"tags":{"description":"Tags","type":"string","maxLength":1000,"example":"example_tags"},"p_asserted_identity":{"description":"P Asserted Identity","type":"string","enum":["default","remove"],"example":"default"},"package_id":{"description":"Package Id","type":"integer","maxLength":10,"minimum":0,"example":1},"recording":{"description":"Recording","type":"integer","nullable":false,"maxLength":255,"minimum":0,"default":"0","example":1},"transcoding":{"description":"Transcoding","type":"integer","maxLength":3,"minimum":0,"default":"0","example":1},"created_date":{"description":"Created Date","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"assigned_date":{"description":"Assigned Date","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"enabled":{"description":"Enabled","type":"integer","nullable":false,"maxLength":255,"minimum":0,"default":"1","example":true},"sandbox_id":{"description":"Sandbox Id","type":"integer","maxLength":10,"minimum":0,"example":1},"scriptforge_timeout":{"description":"Scriptforge Timeout","type":"number","maxLength":5,"minimum":0,"default":"2","example":99.99},"scriptforge_timeout_action":{"description":"Scriptforge Timeout Action","type":"string","maxLength":50,"default":"500 ScriptForge Timeout","example":"example_scriptforge_timeout_action"},"vars":{"description":"Vars","type":"string","example":"Sample vars text content"},"retain_display_name":{"description":"Retain Display Name","type":"integer","maxLength":255,"minimum":0,"example":1},"min_days":{"description":"Min Days","type":"integer","maxLength":10,"minimum":0,"default":"0","example":123},"ftc_reported":{"description":"Ftc Reported","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"rtp_codec":{"description":"Rtp Codec","type":"object","additionalProperties":true,"maxLength":1500,"default":"[]","example":"example_rtp_codec"},"stir_shaken_min_attest":{"description":"Stir Shaken Min Attest","type":"string","enum":["A","B","C"],"example":"A"},"spam_score":{"description":"Spam Score","type":"integer","maxLength":3,"minimum":0,"example":1},"ipqs":{"description":"Ipqs","type":"integer","maxLength":3,"minimum":0,"example":1},"flags":{"description":"Flags","type":"string","nullable":false,"maxLength":1500,"example":"example_flags"},"last_called":{"description":"Last Called","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"block_source_type":{"description":"Block Source Type","type":"string","maxLength":255,"example":"example_block_source_type"},"spam_scout":{"description":"Spam Scout","type":"integer","maxLength":3,"minimum":0,"example":1}},"example":{"id":12345,"account_id":1,"customer_id":1,"provider_id":1,"did":"example_did","provider_card_id":1,"customer_card_id":1,"destination":"example_destination","destination_type":"example_destination_type","destination2":"example_destination2","destination2_type":"example_destination2_type","destination3":"example_destination3","destination3_type":"example_destination3_type","notes":"Sample notes text content","channels":123,"cps":123,"max_duration":123,"rtp_proxy":1,"rtp_mode":"Relaxed","timeout":"SIP Ping","cost":99.99,"retail":99.99,"start_date":"2025-01-17T10:30:00Z","tags":"example_tags","p_asserted_identity":"default","package_id":1,"recording":1,"transcoding":1,"created_date":"2025-01-17T10:30:00Z","assigned_date":"2025-01-17T10:30:00Z","enabled":true,"sandbox_id":1,"scriptforge_timeout":99.99,"scriptforge_timeout_action":"example_scriptforge_timeout_action","vars":"Sample vars text content","retain_display_name":1,"min_days":123,"ftc_reported":1,"rtp_codec":"example_rtp_codec","stir_shaken_min_attest":"A","spam_score":1,"ipqs":1,"flags":"example_flags","last_called":"2025-01-17T10:30:00Z","block_source_type":"example_block_source_type","spam_scout":1}},"didInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"customer_id":{"description":"Customer Id (references company.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"company","referencesColumn":"id"},"example":1},"provider_id":{"description":"Provider Id (references company.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"company","referencesColumn":"id"},"example":1},"did":{"description":"Did","type":"string","maxLength":30,"default":"","example":"example_did"},"provider_card_id":{"description":"Provider Card Id","type":"string","maxLength":10,"example":1},"customer_card_id":{"description":"Customer Card Id","type":"string","maxLength":10,"example":1},"destination":{"description":"Destination","type":"string","nullable":false,"maxLength":100,"default":"","example":"example_destination"},"destination_type":{"description":"Destination Type","type":"string","maxLength":30,"example":"example_destination_type"},"destination2":{"description":"Destination 2","type":"string","maxLength":100,"example":"example_destination2"},"destination2_type":{"description":"Destination 2 Type","type":"string","maxLength":30,"example":"example_destination2_type"},"destination3":{"description":"Destination 3","type":"string","maxLength":100,"example":"example_destination3"},"destination3_type":{"description":"Destination 3 Type","type":"string","maxLength":30,"example":"example_destination3_type"},"notes":{"description":"Notes","type":"string","example":"Sample notes text content"},"channels":{"description":"Channels","type":"integer","maxLength":255,"minimum":0,"example":123},"cps":{"description":"Cps","type":"integer","maxLength":255,"minimum":0,"example":123},"max_duration":{"description":"Max Duration","type":"integer","maxLength":11,"default":"3600","example":123},"rtp_proxy":{"description":"Rtp Proxy","type":"integer","nullable":false,"maxLength":50,"minimum":0,"default":"101","example":1},"rtp_mode":{"description":"Rtp Mode","type":"string","enum":["Relaxed","Strict"],"default":"Strict","example":"Relaxed"},"timeout":{"description":"Timeout","type":"array","items":{"type":"string","enum":["SIP Ping","RTP Proxy"]},"example":"SIP Ping"},"cost":{"description":"Cost","type":"number","maxLength":10,"example":99.99},"retail":{"description":"Retail","type":"number","maxLength":10,"example":99.99},"start_date":{"description":"Start Date","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"tags":{"description":"Tags","type":"string","maxLength":1000,"example":"example_tags"},"p_asserted_identity":{"description":"P Asserted Identity","type":"string","enum":["default","remove"],"example":"default"},"package_id":{"description":"Package Id","type":"integer","maxLength":10,"minimum":0,"example":1},"recording":{"description":"Recording","type":"integer","nullable":false,"maxLength":255,"minimum":0,"default":"0","example":1},"transcoding":{"description":"Transcoding","type":"integer","maxLength":3,"minimum":0,"default":"0","example":1},"created_date":{"description":"Created Date","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"assigned_date":{"description":"Assigned Date","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"enabled":{"description":"Enabled","type":"integer","nullable":false,"maxLength":255,"minimum":0,"default":"1","example":true},"sandbox_id":{"description":"Sandbox Id","type":"integer","maxLength":10,"minimum":0,"example":1},"scriptforge_timeout":{"description":"Scriptforge Timeout","type":"number","maxLength":5,"minimum":0,"default":"2","example":99.99},"scriptforge_timeout_action":{"description":"Scriptforge Timeout Action","type":"string","maxLength":50,"default":"500 ScriptForge Timeout","example":"example_scriptforge_timeout_action"},"vars":{"description":"Vars","type":"string","example":"Sample vars text content"},"retain_display_name":{"description":"Retain Display Name","type":"integer","maxLength":255,"minimum":0,"example":1},"min_days":{"description":"Min Days","type":"integer","maxLength":10,"minimum":0,"default":"0","example":123},"ftc_reported":{"description":"Ftc Reported","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"rtp_codec":{"description":"Rtp Codec","type":"object","additionalProperties":true,"maxLength":1500,"default":"[]","example":"example_rtp_codec"},"stir_shaken_min_attest":{"description":"Stir Shaken Min Attest","type":"string","enum":["A","B","C"],"example":"A"},"spam_score":{"description":"Spam Score","type":"integer","maxLength":3,"minimum":0,"example":1},"ipqs":{"description":"Ipqs","type":"integer","maxLength":3,"minimum":0,"example":1},"flags":{"description":"Flags","type":"string","nullable":false,"maxLength":1500,"example":"example_flags"},"last_called":{"description":"Last Called","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"block_source_type":{"description":"Block Source Type","type":"string","maxLength":255,"example":"example_block_source_type"},"spam_scout":{"description":"Spam Scout","type":"integer","maxLength":3,"minimum":0,"example":1}},"example":{"id":12345,"account_id":1,"customer_id":1,"provider_id":1,"did":"example_did","provider_card_id":1,"customer_card_id":1,"destination":"example_destination","destination_type":"example_destination_type","destination2":"example_destination2","destination2_type":"example_destination2_type","destination3":"example_destination3","destination3_type":"example_destination3_type","notes":"Sample notes text content","channels":123,"cps":123,"max_duration":123,"rtp_proxy":1,"rtp_mode":"Relaxed","timeout":"SIP Ping","cost":99.99,"retail":99.99,"start_date":"2025-01-17T10:30:00Z","tags":"example_tags","p_asserted_identity":"default","package_id":1,"recording":1,"transcoding":1,"created_date":"2025-01-17T10:30:00Z","assigned_date":"2025-01-17T10:30:00Z","enabled":true,"sandbox_id":1,"scriptforge_timeout":99.99,"scriptforge_timeout_action":"example_scriptforge_timeout_action","vars":"Sample vars text content","retain_display_name":1,"min_days":123,"ftc_reported":1,"rtp_codec":"example_rtp_codec","stir_shaken_min_attest":"A","spam_score":1,"ipqs":1,"flags":"example_flags","last_called":"2025-01-17T10:30:00Z","block_source_type":"example_block_source_type","spam_scout":1},"required":["destination","rtp_proxy","recording","enabled","ftc_reported","flags"]},"formBuilder":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"placement":{"description":"Placement","type":"string","maxLength":255,"example":"example_placement"},"schema":{"description":"Schema","type":"object","additionalProperties":true,"example":"Sample schema text content"},"scriptforge_id":{"description":"Scriptforge Id","type":"integer","maxLength":10,"minimum":0,"example":1}},"example":{"id":12345,"account_id":1,"name":"Example Name","placement":"example_placement","schema":"Sample schema text content","scriptforge_id":1}},"formBuilderInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"placement":{"description":"Placement","type":"string","maxLength":255,"example":"example_placement"},"schema":{"description":"Schema","type":"object","additionalProperties":true,"example":"Sample schema text content"},"scriptforge_id":{"description":"Scriptforge Id","type":"integer","maxLength":10,"minimum":0,"example":1}},"example":{"id":12345,"account_id":1,"name":"Example Name","placement":"example_placement","schema":"Sample schema text content","scriptforge_id":1},"required":["name"]},"internalNumberBlock":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":11,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"company_id":{"description":"Company Id (references company.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"company","referencesColumn":"id"},"example":1},"start_block":{"description":"Start Block","type":"integer","maxLength":255,"minimum":0,"example":123},"end_block":{"description":"End Block","type":"integer","maxLength":255,"minimum":0,"example":123}},"example":{"id":12345,"account_id":1,"company_id":1,"start_block":123,"end_block":123}},"internalNumberBlockInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":11,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"company_id":{"description":"Company Id (references company.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"company","referencesColumn":"id"},"example":1},"start_block":{"description":"Start Block","type":"integer","maxLength":255,"minimum":0,"example":123},"end_block":{"description":"End Block","type":"integer","maxLength":255,"minimum":0,"example":123}},"example":{"id":12345,"account_id":1,"company_id":1,"start_block":123,"end_block":123}},"invoice":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"invoice_id":{"description":"Invoice Id","type":"integer","maxLength":10,"minimum":0,"example":1},"company_id":{"description":"Company Id","type":"integer","maxLength":10,"minimum":0,"example":1},"to_address":{"description":"To Address","type":"string","maxLength":1000,"example":"example_to_address"},"invoice_date":{"description":"Invoice Date","type":"string","format":"date","example":"2025-01-17T10:30:00Z"},"sent":{"description":"Sent","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"external_id":{"description":"External Id","type":"string","maxLength":255,"example":1}},"example":{"id":12345,"account_id":1,"invoice_id":1,"company_id":1,"to_address":"example_to_address","invoice_date":"2025-01-17T10:30:00Z","sent":1,"external_id":1}},"invoiceInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"invoice_id":{"description":"Invoice Id","type":"integer","maxLength":10,"minimum":0,"example":1},"company_id":{"description":"Company Id","type":"integer","maxLength":10,"minimum":0,"example":1},"to_address":{"description":"To Address","type":"string","maxLength":1000,"example":"example_to_address"},"invoice_date":{"description":"Invoice Date","type":"string","format":"date","example":"2025-01-17T10:30:00Z"},"sent":{"description":"Sent","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"external_id":{"description":"External Id","type":"string","maxLength":255,"example":1}},"example":{"id":12345,"account_id":1,"invoice_id":1,"company_id":1,"to_address":"example_to_address","invoice_date":"2025-01-17T10:30:00Z","sent":1,"external_id":1},"required":["sent"]},"lookup":{"type":"object","properties":{"country":{"description":"Country","type":"string","maxLength":255,"example":"US"},"iso3166_3":{"description":"Iso 3166 3","type":"string","maxLength":3,"example":"example_iso3166_3"},"iso3166_2":{"description":"Iso 3166 2","type":"string","maxLength":2,"example":"example_iso3166_2"},"idd":{"description":"Idd","type":"string","maxLength":20,"example":"example_idd"},"prefix":{"description":"Prefix","type":"string","maxLength":50,"example":"example_prefix"},"cc":{"description":"Cc","type":"string","maxLength":4,"example":"example_cc"},"ndc1":{"description":"Ndc 1","type":"string","maxLength":10,"example":"example_ndc1"},"ndc1t":{"description":"Ndc 1 T","type":"string","maxLength":10,"example":"example_ndc1t"},"ndc2":{"description":"Ndc 2","type":"string","maxLength":10,"example":"example_ndc2"},"sn1":{"description":"Sn 1","type":"string","maxLength":10,"example":"example_sn1"},"sn1t":{"description":"Sn 1 T","type":"string","maxLength":10,"example":"example_sn1t"},"sn2":{"description":"Sn 2","type":"string","maxLength":20,"example":"example_sn2"},"snl":{"description":"Snl","type":"string","maxLength":8,"example":"example_snl"},"description":{"description":"Description","type":"string","maxLength":100,"example":"A detailed description of the resource"},"type":{"description":"Type","type":"string","maxLength":30,"example":"example_type"},"test_numbers":{"description":"Test Numbers","type":"string","maxLength":100,"example":"example_test_numbers"},"start_date":{"description":"Start Date","type":"string","format":"date","example":"2025-01-17T10:30:00Z"},"end_date":{"description":"End Date","type":"string","format":"date","example":"2025-01-17T10:30:00Z"},"last_update":{"description":"Last Update","type":"string","format":"date","nullable":true,"example":"2025-01-17"},"net_name":{"description":"Net Name","type":"string","maxLength":255,"example":"example_net_name"},"net_type":{"description":"Net Type","type":"string","maxLength":255,"example":"example_net_type"},"mcc":{"description":"Mcc","type":"string","maxLength":20,"example":"example_mcc"},"mnc":{"description":"Mnc","type":"string","maxLength":100,"example":"example_mnc"},"tadig_nc":{"description":"Tadig Nc","type":"string","maxLength":50,"example":"example_tadig_nc"},"handset_code":{"description":"Handset Code","type":"string","maxLength":100,"example":"example_handset_code"},"net_start_date":{"description":"Net Start Date","type":"string","format":"date","example":"2025-01-17T10:30:00Z"},"net_end_date":{"description":"Net End Date","type":"string","format":"date","example":"2025-01-17T10:30:00Z"},"operator":{"description":"Operator","type":"string","maxLength":100,"example":"example_operator"},"licensed_service_areas":{"description":"Licensed Service Areas","type":"string","maxLength":100,"example":"example_licensed_service_areas"},"country_notes":{"description":"Country Notes","type":"string","maxLength":255,"example":10},"nop_notes":{"description":"Nop Notes","type":"string","maxLength":255,"example":"example_nop_notes"},"net_notes":{"description":"Net Notes","type":"string","maxLength":255,"example":"example_net_notes"},"prefix_notes":{"description":"Prefix Notes","type":"string","maxLength":255,"example":"example_prefix_notes"},"row_insertion_date":{"description":"Row Insertion Date","type":"string","format":"date","example":"2025-01-17T10:30:00Z"}},"example":{"country":"US","iso3166_3":"example_iso3166_3","iso3166_2":"example_iso3166_2","idd":"example_idd","prefix":"example_prefix","cc":"example_cc","ndc1":"example_ndc1","ndc1t":"example_ndc1t","ndc2":"example_ndc2","sn1":"example_sn1","sn1t":"example_sn1t","sn2":"example_sn2","snl":"example_snl","description":"A detailed description of the resource","type":"example_type","test_numbers":"example_test_numbers","start_date":"2025-01-17T10:30:00Z","end_date":"2025-01-17T10:30:00Z","last_update":"2025-01-17","net_name":"example_net_name","net_type":"example_net_type","mcc":"example_mcc","mnc":"example_mnc","tadig_nc":"example_tadig_nc","handset_code":"example_handset_code","net_start_date":"2025-01-17T10:30:00Z","net_end_date":"2025-01-17T10:30:00Z","operator":"example_operator","licensed_service_areas":"example_licensed_service_areas","country_notes":10,"nop_notes":"example_nop_notes","net_notes":"example_net_notes","prefix_notes":"example_prefix_notes","row_insertion_date":"2025-01-17T10:30:00Z"}},"reportSchedule":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":11,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"email":{"description":"Email","type":"string","format":"email","maxLength":255,"example":"user@example.com"},"frequency":{"description":"Frequency","type":"string","enum":["day","week","month"],"default":"week","example":"day"},"query":{"description":"Query","type":"object","additionalProperties":true,"example":"Sample query text content"}},"example":{"id":12345,"account_id":1,"name":"Example Name","email":"user@example.com","frequency":"day","query":"Sample query text content"}},"reportScheduleInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":11,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"email":{"description":"Email","type":"string","format":"email","maxLength":255,"example":"user@example.com"},"frequency":{"description":"Frequency","type":"string","enum":["day","week","month"],"default":"week","example":"day"},"query":{"description":"Query","type":"object","additionalProperties":true,"example":"Sample query text content"}},"example":{"id":12345,"account_id":1,"name":"Example Name","email":"user@example.com","frequency":"day","query":"Sample query text content"},"required":["name"]},"routeStrategy":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"name":{"description":"Name","type":"string","maxLength":100,"example":"Example Name"},"strategy":{"description":"Strategy","type":"string","maxLength":100,"example":"example_strategy"},"cards":{"description":"Cards","type":"object","additionalProperties":true,"maxLength":1000,"example":"example_cards"},"override_routing":{"description":"Override Routing","type":"integer","nullable":false,"maxLength":3,"minimum":0,"example":1}},"example":{"id":12345,"account_id":1,"name":"Example Name","strategy":"example_strategy","cards":"example_cards","override_routing":1}},"routeStrategyInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"name":{"description":"Name","type":"string","maxLength":100,"example":"Example Name"},"strategy":{"description":"Strategy","type":"string","maxLength":100,"example":"example_strategy"},"cards":{"description":"Cards","type":"object","additionalProperties":true,"maxLength":1000,"example":"example_cards"},"override_routing":{"description":"Override Routing","type":"integer","nullable":false,"maxLength":3,"minimum":0,"example":1}},"example":{"id":12345,"account_id":1,"name":"Example Name","strategy":"example_strategy","cards":"example_cards","override_routing":1},"required":["name","override_routing"]},"routingGlobal":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"tag":{"description":"Tag","type":"string","maxLength":255,"example":"example_tag"},"card_id":{"description":"Card Id","type":"string","maxLength":255,"example":1},"prefix":{"description":"Prefix","type":"string","nullable":false,"maxLength":255,"example":"example_prefix"},"revision":{"description":"Revision","type":"integer","maxLength":11,"example":123},"channels":{"description":"Channels","type":"integer","nullable":false,"maxLength":11,"minimum":0,"default":"5","example":123},"cps":{"description":"Cps","type":"integer","maxLength":10,"minimum":0,"example":123},"cps_buffer":{"description":"Cps Buffer","type":"integer","maxLength":3,"minimum":0,"example":1},"max_duration":{"description":"Max Duration","type":"integer","maxLength":11,"default":"3600","example":123},"allow_ported":{"description":"Allow Ported","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"1","example":1},"transcoding":{"description":"Transcoding","type":"integer","maxLength":3,"minimum":0,"default":"0","example":1},"capped":{"description":"Capped","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"tps":{"description":"Tps","type":"integer","maxLength":10,"example":1},"asr_plus":{"description":"Asr Plus","type":"integer","maxLength":10,"default":"1","example":1},"recording":{"description":"Recording","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"recording_duration":{"description":"Recording Duration","type":"integer","maxLength":10,"minimum":0,"example":123},"transcribe":{"description":"Transcribe","type":"integer","nullable":false,"maxLength":255,"minimum":0,"default":"0","example":1},"transcribe_duration":{"description":"Transcribe Duration","type":"integer","maxLength":10,"minimum":0,"example":123},"rtp_proxy":{"description":"Rtp Proxy","type":"integer","nullable":false,"maxLength":50,"minimum":0,"default":"101","example":1},"rtp_mode":{"description":"Rtp Mode","type":"string","enum":["Relaxed","Strict"],"default":"Strict","example":"Relaxed"},"timeout":{"description":"Timeout","type":"array","items":{"type":"string","enum":["SIP Ping","RTP Proxy"]},"example":"SIP Ping"},"sip_ping":{"description":"Sip Ping","type":"integer","nullable":false,"maxLength":255,"minimum":0,"default":"1","example":1},"rtp_timeout":{"description":"Rtp Timeout","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"1","example":1},"sip_session_timers":{"description":"Sip Session Timers","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"fix_ok_cancel_race_uac_bug":{"description":"Fix Ok Cancel Race Uac Bug","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"pre_ring_timeout":{"description":"Pre Ring Timeout","type":"integer","maxLength":3,"minimum":0,"example":1},"post_ring_timeout":{"description":"Post Ring Timeout","type":"integer","maxLength":3,"minimum":0,"example":1},"fallthrough":{"description":"Fallthrough","type":"integer","nullable":false,"maxLength":4,"minimum":0,"default":"100","example":1},"carrier_list":{"description":"Carrier List","type":"string","maxLength":100,"example":"example_carrier_list"},"dialstring":{"description":"Dialstring","type":"string","maxLength":8000,"example":"example_dialstring"},"dialstring_prefix_set_id":{"description":"Dialstring Prefix Set Id","type":"integer","maxLength":10,"minimum":0,"example":1},"egress_group_id":{"description":"Egress Group Id","type":"integer","maxLength":10,"minimum":0,"example":1},"redirect_uri":{"description":"Redirect Uri","type":"string","maxLength":100,"example":"example_redirect_uri"},"redirect_exclude":{"description":"Redirect Exclude","type":"string","maxLength":50,"default":"404,408,486,487,603,604","example":"example_redirect_exclude"},"reply_map":{"description":"Reply Map","type":"string","maxLength":200,"example":"example_reply_map"},"capped_rate":{"description":"Capped Rate","type":"number","maxLength":8,"example":99.99},"capped_rate_prov":{"description":"Capped Rate Prov","type":"number","maxLength":8,"example":99.99},"block_connect_cost":{"description":"Block Connect Cost","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":99.99},"block_destination_type":{"description":"Block Destination Type","type":"string","maxLength":255,"example":"example_block_destination_type"},"spam_scout":{"description":"Spam Scout","type":"integer","maxLength":3,"minimum":0,"default":"100","example":1},"ipqs":{"description":"Ipqs","type":"integer","maxLength":3,"minimum":0,"default":"100","example":1},"override_lcr":{"description":"Override Lcr","type":"string","maxLength":500,"example":"example_override_lcr"},"profit_assurance":{"description":"Profit Assurance","type":"number","maxLength":3,"example":99.99},"exclude_card":{"description":"Exclude Card","type":"string","maxLength":200,"example":"example_exclude_card"},"lock_card":{"description":"Lock Card","type":"string","maxLength":200,"example":"example_lock_card"},"sandbox_id":{"description":"Sandbox Id","type":"integer","maxLength":10,"example":1},"scriptforge_timeout":{"description":"Scriptforge Timeout","type":"number","maxLength":5,"minimum":0,"example":99.99},"scriptforge_timeout_action":{"description":"Scriptforge Timeout Action","type":"string","maxLength":50,"example":"example_scriptforge_timeout_action"},"vars":{"description":"Vars","type":"string","maxLength":255,"example":"example_vars"},"protocol":{"description":"Protocol","type":"string","enum":["SIP","SMPP"],"default":"SIP","example":"SIP"},"strategy":{"description":"Strategy","type":"object","additionalProperties":true,"maxLength":5000,"example":"example_strategy"},"remove_allow_inv":{"description":"Remove Allow Inv","type":"integer","maxLength":1,"minimum":0,"default":"0","example":1},"approved_by":{"description":"Approved By","type":"string","maxLength":255,"example":"example_approved_by"},"approved_date":{"description":"Approved Date","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"enabled":{"description":"Enabled","type":"integer","maxLength":3,"minimum":0,"default":"1","example":true},"auto":{"description":"Auto","type":"integer","maxLength":255,"minimum":0,"default":"0","example":1},"public_notes":{"description":"Public Notes","type":"string","example":"Sample public_notes text content"},"private_notes":{"description":"Private Notes","type":"string","example":"Sample private_notes text content"},"fraud_profile_id":{"description":"Fraud Profile Id","type":"integer","maxLength":10,"minimum":0,"example":1},"fraud_mode":{"description":"Fraud Mode","type":"integer","nullable":false,"maxLength":255,"minimum":0,"example":1},"ftc_dnc_report":{"description":"Ftc Dnc Report","type":"integer","maxLength":255,"minimum":0,"example":1},"dno":{"description":"Dno","type":"integer","maxLength":10,"minimum":0,"default":"0","example":123},"inter_customer":{"description":"Inter Customer","type":"integer","maxLength":255,"minimum":0,"default":"0","example":1},"dnc_list":{"description":"Dnc List","type":"string","maxLength":255,"example":"example_dnc_list"},"block_dtmf":{"description":"Block Dtmf","type":"integer","maxLength":255,"minimum":0,"default":"0","example":1},"realtime":{"description":"Realtime","type":"integer","maxLength":3,"minimum":0,"example":1},"redial_max_count":{"description":"Redial Max Count","type":"integer","maxLength":3,"minimum":0,"example":10},"redial_max_period":{"description":"Redial Max Period","type":"integer","maxLength":8,"minimum":0,"example":1000},"rtp_codec":{"description":"Rtp Codec","type":"object","additionalProperties":true,"maxLength":500,"example":"example_rtp_codec"},"stir_shaken_min_attest":{"description":"Stir Shaken Min Attest","type":"string","enum":["A","B","C"],"example":"A"},"flags":{"description":"Flags","type":"string","nullable":false,"maxLength":255,"example":"example_flags"},"pbx_server":{"description":"Pbx Server","type":"string","maxLength":255,"example":"example_pbx_server"}},"example":{"id":12345,"account_id":1,"name":"Example Name","tag":"example_tag","card_id":1,"prefix":"example_prefix","revision":123,"channels":123,"cps":123,"cps_buffer":1,"max_duration":123,"allow_ported":1,"transcoding":1,"capped":1,"tps":1,"asr_plus":1,"recording":1,"recording_duration":123,"transcribe":1,"transcribe_duration":123,"rtp_proxy":1,"rtp_mode":"Relaxed","timeout":"SIP Ping","sip_ping":1,"rtp_timeout":1,"sip_session_timers":1,"fix_ok_cancel_race_uac_bug":1,"pre_ring_timeout":1,"post_ring_timeout":1,"fallthrough":1,"carrier_list":"example_carrier_list","dialstring":"example_dialstring","dialstring_prefix_set_id":1,"egress_group_id":1,"redirect_uri":"example_redirect_uri","redirect_exclude":"example_redirect_exclude","reply_map":"example_reply_map","capped_rate":99.99,"capped_rate_prov":99.99,"block_connect_cost":99.99,"block_destination_type":"example_block_destination_type","spam_scout":1,"ipqs":1,"override_lcr":"example_override_lcr","profit_assurance":99.99,"exclude_card":"example_exclude_card","lock_card":"example_lock_card","sandbox_id":1,"scriptforge_timeout":99.99,"scriptforge_timeout_action":"example_scriptforge_timeout_action","vars":"example_vars","protocol":"SIP","strategy":"example_strategy","remove_allow_inv":1,"approved_by":"example_approved_by","approved_date":"2025-01-17T10:30:00Z","enabled":true,"auto":1,"public_notes":"Sample public_notes text content","private_notes":"Sample private_notes text content","fraud_profile_id":1,"fraud_mode":1,"ftc_dnc_report":1,"dno":123,"inter_customer":1,"dnc_list":"example_dnc_list","block_dtmf":1,"realtime":1,"redial_max_count":10,"redial_max_period":1000,"rtp_codec":"example_rtp_codec","stir_shaken_min_attest":"A","flags":"example_flags","pbx_server":"example_pbx_server"}},"routingGlobalInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"tag":{"description":"Tag","type":"string","maxLength":255,"example":"example_tag"},"card_id":{"description":"Card Id","type":"string","maxLength":255,"example":1},"prefix":{"description":"Prefix","type":"string","nullable":false,"maxLength":255,"example":"example_prefix"},"revision":{"description":"Revision","type":"integer","maxLength":11,"example":123},"channels":{"description":"Channels","type":"integer","nullable":false,"maxLength":11,"minimum":0,"default":"5","example":123},"cps":{"description":"Cps","type":"integer","maxLength":10,"minimum":0,"example":123},"cps_buffer":{"description":"Cps Buffer","type":"integer","maxLength":3,"minimum":0,"example":1},"max_duration":{"description":"Max Duration","type":"integer","maxLength":11,"default":"3600","example":123},"allow_ported":{"description":"Allow Ported","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"1","example":1},"transcoding":{"description":"Transcoding","type":"integer","maxLength":3,"minimum":0,"default":"0","example":1},"capped":{"description":"Capped","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"tps":{"description":"Tps","type":"integer","maxLength":10,"example":1},"asr_plus":{"description":"Asr Plus","type":"integer","maxLength":10,"default":"1","example":1},"recording":{"description":"Recording","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"recording_duration":{"description":"Recording Duration","type":"integer","maxLength":10,"minimum":0,"example":123},"transcribe":{"description":"Transcribe","type":"integer","nullable":false,"maxLength":255,"minimum":0,"default":"0","example":1},"transcribe_duration":{"description":"Transcribe Duration","type":"integer","maxLength":10,"minimum":0,"example":123},"rtp_proxy":{"description":"Rtp Proxy","type":"integer","nullable":false,"maxLength":50,"minimum":0,"default":"101","example":1},"rtp_mode":{"description":"Rtp Mode","type":"string","enum":["Relaxed","Strict"],"default":"Strict","example":"Relaxed"},"timeout":{"description":"Timeout","type":"array","items":{"type":"string","enum":["SIP Ping","RTP Proxy"]},"example":"SIP Ping"},"sip_ping":{"description":"Sip Ping","type":"integer","nullable":false,"maxLength":255,"minimum":0,"default":"1","example":1},"rtp_timeout":{"description":"Rtp Timeout","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"1","example":1},"sip_session_timers":{"description":"Sip Session Timers","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"fix_ok_cancel_race_uac_bug":{"description":"Fix Ok Cancel Race Uac Bug","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"pre_ring_timeout":{"description":"Pre Ring Timeout","type":"integer","maxLength":3,"minimum":0,"example":1},"post_ring_timeout":{"description":"Post Ring Timeout","type":"integer","maxLength":3,"minimum":0,"example":1},"fallthrough":{"description":"Fallthrough","type":"integer","nullable":false,"maxLength":4,"minimum":0,"default":"100","example":1},"carrier_list":{"description":"Carrier List","type":"string","maxLength":100,"example":"example_carrier_list"},"dialstring":{"description":"Dialstring","type":"string","maxLength":8000,"example":"example_dialstring"},"dialstring_prefix_set_id":{"description":"Dialstring Prefix Set Id","type":"integer","maxLength":10,"minimum":0,"example":1},"egress_group_id":{"description":"Egress Group Id","type":"integer","maxLength":10,"minimum":0,"example":1},"redirect_uri":{"description":"Redirect Uri","type":"string","maxLength":100,"example":"example_redirect_uri"},"redirect_exclude":{"description":"Redirect Exclude","type":"string","maxLength":50,"default":"404,408,486,487,603,604","example":"example_redirect_exclude"},"reply_map":{"description":"Reply Map","type":"string","maxLength":200,"example":"example_reply_map"},"capped_rate":{"description":"Capped Rate","type":"number","maxLength":8,"example":99.99},"capped_rate_prov":{"description":"Capped Rate Prov","type":"number","maxLength":8,"example":99.99},"block_connect_cost":{"description":"Block Connect Cost","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":99.99},"block_destination_type":{"description":"Block Destination Type","type":"string","maxLength":255,"example":"example_block_destination_type"},"spam_scout":{"description":"Spam Scout","type":"integer","maxLength":3,"minimum":0,"default":"100","example":1},"ipqs":{"description":"Ipqs","type":"integer","maxLength":3,"minimum":0,"default":"100","example":1},"override_lcr":{"description":"Override Lcr","type":"string","maxLength":500,"example":"example_override_lcr"},"profit_assurance":{"description":"Profit Assurance","type":"number","maxLength":3,"example":99.99},"exclude_card":{"description":"Exclude Card","type":"string","maxLength":200,"example":"example_exclude_card"},"lock_card":{"description":"Lock Card","type":"string","maxLength":200,"example":"example_lock_card"},"sandbox_id":{"description":"Sandbox Id","type":"integer","maxLength":10,"example":1},"scriptforge_timeout":{"description":"Scriptforge Timeout","type":"number","maxLength":5,"minimum":0,"example":99.99},"scriptforge_timeout_action":{"description":"Scriptforge Timeout Action","type":"string","maxLength":50,"example":"example_scriptforge_timeout_action"},"vars":{"description":"Vars","type":"string","maxLength":255,"example":"example_vars"},"protocol":{"description":"Protocol","type":"string","enum":["SIP","SMPP"],"default":"SIP","example":"SIP"},"strategy":{"description":"Strategy","type":"object","additionalProperties":true,"maxLength":5000,"example":"example_strategy"},"remove_allow_inv":{"description":"Remove Allow Inv","type":"integer","maxLength":1,"minimum":0,"default":"0","example":1},"approved_by":{"description":"Approved By","type":"string","maxLength":255,"example":"example_approved_by"},"approved_date":{"description":"Approved Date","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"enabled":{"description":"Enabled","type":"integer","maxLength":3,"minimum":0,"default":"1","example":true},"auto":{"description":"Auto","type":"integer","maxLength":255,"minimum":0,"default":"0","example":1},"public_notes":{"description":"Public Notes","type":"string","example":"Sample public_notes text content"},"private_notes":{"description":"Private Notes","type":"string","example":"Sample private_notes text content"},"fraud_profile_id":{"description":"Fraud Profile Id","type":"integer","maxLength":10,"minimum":0,"example":1},"fraud_mode":{"description":"Fraud Mode","type":"integer","nullable":false,"maxLength":255,"minimum":0,"example":1},"ftc_dnc_report":{"description":"Ftc Dnc Report","type":"integer","maxLength":255,"minimum":0,"example":1},"dno":{"description":"Dno","type":"integer","maxLength":10,"minimum":0,"default":"0","example":123},"inter_customer":{"description":"Inter Customer","type":"integer","maxLength":255,"minimum":0,"default":"0","example":1},"dnc_list":{"description":"Dnc List","type":"string","maxLength":255,"example":"example_dnc_list"},"block_dtmf":{"description":"Block Dtmf","type":"integer","maxLength":255,"minimum":0,"default":"0","example":1},"realtime":{"description":"Realtime","type":"integer","maxLength":3,"minimum":0,"example":1},"redial_max_count":{"description":"Redial Max Count","type":"integer","maxLength":3,"minimum":0,"example":10},"redial_max_period":{"description":"Redial Max Period","type":"integer","maxLength":8,"minimum":0,"example":1000},"rtp_codec":{"description":"Rtp Codec","type":"object","additionalProperties":true,"maxLength":500,"example":"example_rtp_codec"},"stir_shaken_min_attest":{"description":"Stir Shaken Min Attest","type":"string","enum":["A","B","C"],"example":"A"},"flags":{"description":"Flags","type":"string","nullable":false,"maxLength":255,"example":"example_flags"},"pbx_server":{"description":"Pbx Server","type":"string","maxLength":255,"example":"example_pbx_server"}},"example":{"id":12345,"account_id":1,"name":"Example Name","tag":"example_tag","card_id":1,"prefix":"example_prefix","revision":123,"channels":123,"cps":123,"cps_buffer":1,"max_duration":123,"allow_ported":1,"transcoding":1,"capped":1,"tps":1,"asr_plus":1,"recording":1,"recording_duration":123,"transcribe":1,"transcribe_duration":123,"rtp_proxy":1,"rtp_mode":"Relaxed","timeout":"SIP Ping","sip_ping":1,"rtp_timeout":1,"sip_session_timers":1,"fix_ok_cancel_race_uac_bug":1,"pre_ring_timeout":1,"post_ring_timeout":1,"fallthrough":1,"carrier_list":"example_carrier_list","dialstring":"example_dialstring","dialstring_prefix_set_id":1,"egress_group_id":1,"redirect_uri":"example_redirect_uri","redirect_exclude":"example_redirect_exclude","reply_map":"example_reply_map","capped_rate":99.99,"capped_rate_prov":99.99,"block_connect_cost":99.99,"block_destination_type":"example_block_destination_type","spam_scout":1,"ipqs":1,"override_lcr":"example_override_lcr","profit_assurance":99.99,"exclude_card":"example_exclude_card","lock_card":"example_lock_card","sandbox_id":1,"scriptforge_timeout":99.99,"scriptforge_timeout_action":"example_scriptforge_timeout_action","vars":"example_vars","protocol":"SIP","strategy":"example_strategy","remove_allow_inv":1,"approved_by":"example_approved_by","approved_date":"2025-01-17T10:30:00Z","enabled":true,"auto":1,"public_notes":"Sample public_notes text content","private_notes":"Sample private_notes text content","fraud_profile_id":1,"fraud_mode":1,"ftc_dnc_report":1,"dno":123,"inter_customer":1,"dnc_list":"example_dnc_list","block_dtmf":1,"realtime":1,"redial_max_count":10,"redial_max_period":1000,"rtp_codec":"example_rtp_codec","stir_shaken_min_attest":"A","flags":"example_flags","pbx_server":"example_pbx_server"},"required":["name","prefix","channels","allow_ported","capped","recording","transcribe","rtp_proxy","sip_ping","rtp_timeout","sip_session_timers","fix_ok_cancel_race_uac_bug","fallthrough","block_connect_cost","fraud_mode","flags"]},"scriptForge":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"app_id":{"description":"App Id","type":"string","maxLength":40,"example":1},"uuid":{"description":"Uuid","type":"string","format":"uuid","maxLength":40,"default":"","example":"example_uuid"},"name":{"description":"Name","type":"string","nullable":false,"maxLength":100,"example":"Example Name"},"language":{"description":"Language","type":"string","nullable":false,"maxLength":20,"default":"javascript","example":"example_language"},"code":{"description":"Code","type":"string","example":"Sample code text content"},"timeout":{"description":"Timeout","type":"integer","maxLength":10,"minimum":0,"default":"3","example":123},"processes":{"description":"Processes","type":"integer","maxLength":255,"minimum":0,"default":"1","example":1},"active":{"description":"Active","type":"integer","nullable":false,"maxLength":3,"minimum":0,"example":true},"form_id":{"description":"Form Id","type":"integer","maxLength":10,"minimum":0,"example":1},"async":{"description":"Async","type":"integer","nullable":false,"maxLength":3,"minimum":0,"example":1},"public":{"description":"Public","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"type":{"description":"Type","type":"string","enum":["legacy","script","app","debug","driver","worker","quickjs"],"default":"script","example":"legacy"},"version":{"description":"Version","type":"string","maxLength":8,"example":"example_version"},"scriptforge_repo_id":{"description":"Scriptforge Repo Id","type":"integer","maxLength":10,"minimum":0,"example":1},"scriptforge_repo_version":{"description":"Scriptforge Repo Version","type":"string","maxLength":10,"example":"example_scriptforge_repo_version"},"c5_dest":{"description":"C 5 Dest","type":"string","maxLength":255,"example":"example_c5_dest"},"pbx_server":{"description":"Pbx Server","type":"string","maxLength":255,"default":"pbx.connexcs.com","example":"example_pbx_server"},"global_routing_priority":{"description":"Global Routing Priority","type":"integer","nullable":false,"maxLength":255,"minimum":0,"default":"0","example":1},"cron":{"description":"Cron","type":"string","maxLength":255,"example":"example_cron"},"ram":{"description":"Ram","type":"integer","maxLength":10,"minimum":0,"example":123},"load":{"description":"Load","type":"number","minimum":0,"example":1.5},"hosts":{"description":"Hosts","type":"string","maxLength":255,"example":"example_hosts"}},"example":{"id":12345,"account_id":1,"app_id":1,"uuid":"example_uuid","name":"Example Name","language":"example_language","code":"Sample code text content","timeout":123,"processes":1,"active":true,"form_id":1,"async":1,"public":1,"type":"legacy","version":"example_version","scriptforge_repo_id":1,"scriptforge_repo_version":"example_scriptforge_repo_version","c5_dest":"example_c5_dest","pbx_server":"example_pbx_server","global_routing_priority":1,"cron":"example_cron","ram":123,"load":1.5,"hosts":"example_hosts"}},"scriptForgeInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"app_id":{"description":"App Id","type":"string","maxLength":40,"example":1},"uuid":{"description":"Uuid","type":"string","format":"uuid","maxLength":40,"default":"","example":"example_uuid"},"name":{"description":"Name","type":"string","nullable":false,"maxLength":100,"example":"Example Name"},"language":{"description":"Language","type":"string","nullable":false,"maxLength":20,"default":"javascript","example":"example_language"},"code":{"description":"Code","type":"string","example":"Sample code text content"},"timeout":{"description":"Timeout","type":"integer","maxLength":10,"minimum":0,"default":"3","example":123},"processes":{"description":"Processes","type":"integer","maxLength":255,"minimum":0,"default":"1","example":1},"active":{"description":"Active","type":"integer","nullable":false,"maxLength":3,"minimum":0,"example":true},"form_id":{"description":"Form Id","type":"integer","maxLength":10,"minimum":0,"example":1},"async":{"description":"Async","type":"integer","nullable":false,"maxLength":3,"minimum":0,"example":1},"public":{"description":"Public","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"type":{"description":"Type","type":"string","enum":["legacy","script","app","debug","driver","worker","quickjs"],"default":"script","example":"legacy"},"version":{"description":"Version","type":"string","maxLength":8,"example":"example_version"},"scriptforge_repo_id":{"description":"Scriptforge Repo Id","type":"integer","maxLength":10,"minimum":0,"example":1},"scriptforge_repo_version":{"description":"Scriptforge Repo Version","type":"string","maxLength":10,"example":"example_scriptforge_repo_version"},"c5_dest":{"description":"C 5 Dest","type":"string","maxLength":255,"example":"example_c5_dest"},"pbx_server":{"description":"Pbx Server","type":"string","maxLength":255,"default":"pbx.connexcs.com","example":"example_pbx_server"},"global_routing_priority":{"description":"Global Routing Priority","type":"integer","nullable":false,"maxLength":255,"minimum":0,"default":"0","example":1},"cron":{"description":"Cron","type":"string","maxLength":255,"example":"example_cron"},"ram":{"description":"Ram","type":"integer","maxLength":10,"minimum":0,"example":123},"load":{"description":"Load","type":"number","minimum":0,"example":1.5},"hosts":{"description":"Hosts","type":"string","maxLength":255,"example":"example_hosts"}},"example":{"id":12345,"account_id":1,"app_id":1,"uuid":"example_uuid","name":"Example Name","language":"example_language","code":"Sample code text content","timeout":123,"processes":1,"active":true,"form_id":1,"async":1,"public":1,"type":"legacy","version":"example_version","scriptforge_repo_id":1,"scriptforge_repo_version":"example_scriptforge_repo_version","c5_dest":"example_c5_dest","pbx_server":"example_pbx_server","global_routing_priority":1,"cron":"example_cron","ram":123,"load":1.5,"hosts":"example_hosts"},"required":["name","language","active","async","public","global_routing_priority"]},"sipDevice":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"uid":{"description":"Uid","type":"string","nullable":false,"maxLength":50,"example":"example_uid"},"account_id":{"description":"Account Id (references account.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"company_id":{"description":"Company Id","type":"integer","maxLength":10,"minimum":0,"example":1},"make":{"description":"Make","type":"string","maxLength":255,"example":"example_make"},"model":{"description":"Model","type":"string","maxLength":255,"example":"example_model"},"status":{"description":"Status","type":"string","maxLength":255,"example":"Active"},"password":{"description":"Password","type":"string","format":"password","maxLength":255,"example":"********"},"admin_password":{"description":"Admin Password","type":"string","format":"password","maxLength":255,"example":"example_admin_password"},"prov_uri":{"description":"Prov Uri","type":"string","maxLength":255,"example":"example_prov_uri"},"firmware_uri":{"description":"Firmware Uri","type":"string","maxLength":255,"example":"example_firmware_uri"},"phonebook_uri":{"description":"Phonebook Uri","type":"string","maxLength":255,"example":"example_phonebook_uri"},"activate_date":{"description":"Activate Date","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"request_date":{"description":"Request Date","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"last_ip":{"description":"Last Ip","type":"string","format":"ipv4","nullable":true,"maxLength":255,"example":"example_last_ip"},"retail":{"description":"Retail","type":"number","maxLength":8,"example":99.99},"package_id":{"description":"Package Id","type":"integer","maxLength":10,"minimum":0,"example":1},"vars":{"description":"Vars","type":"string","maxLength":255,"example":"example_vars"}},"example":{"id":12345,"uid":"example_uid","account_id":1,"company_id":1,"make":"example_make","model":"example_model","status":"Active","password":"********","admin_password":"example_admin_password","prov_uri":"example_prov_uri","firmware_uri":"example_firmware_uri","phonebook_uri":"example_phonebook_uri","activate_date":"2025-01-17T10:30:00Z","request_date":"2025-01-17T10:30:00Z","last_ip":"example_last_ip","retail":99.99,"package_id":1,"vars":"example_vars"}},"sipDeviceInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"uid":{"description":"Uid","type":"string","nullable":false,"maxLength":50,"example":"example_uid"},"account_id":{"description":"Account Id (references account.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"company_id":{"description":"Company Id","type":"integer","maxLength":10,"minimum":0,"example":1},"make":{"description":"Make","type":"string","maxLength":255,"example":"example_make"},"model":{"description":"Model","type":"string","maxLength":255,"example":"example_model"},"status":{"description":"Status","type":"string","maxLength":255,"example":"Active"},"password":{"description":"Password","type":"string","format":"password","maxLength":255,"example":"********"},"admin_password":{"description":"Admin Password","type":"string","format":"password","maxLength":255,"example":"example_admin_password"},"prov_uri":{"description":"Prov Uri","type":"string","maxLength":255,"example":"example_prov_uri"},"firmware_uri":{"description":"Firmware Uri","type":"string","maxLength":255,"example":"example_firmware_uri"},"phonebook_uri":{"description":"Phonebook Uri","type":"string","maxLength":255,"example":"example_phonebook_uri"},"activate_date":{"description":"Activate Date","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"request_date":{"description":"Request Date","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"last_ip":{"description":"Last Ip","type":"string","format":"ipv4","nullable":true,"maxLength":255,"example":"example_last_ip"},"retail":{"description":"Retail","type":"number","maxLength":8,"example":99.99},"package_id":{"description":"Package Id","type":"integer","maxLength":10,"minimum":0,"example":1},"vars":{"description":"Vars","type":"string","maxLength":255,"example":"example_vars"}},"example":{"id":12345,"uid":"example_uid","account_id":1,"company_id":1,"make":"example_make","model":"example_model","status":"Active","password":"********","admin_password":"example_admin_password","prov_uri":"example_prov_uri","firmware_uri":"example_firmware_uri","phonebook_uri":"example_phonebook_uri","activate_date":"2025-01-17T10:30:00Z","request_date":"2025-01-17T10:30:00Z","last_ip":"example_last_ip","retail":99.99,"package_id":1,"vars":"example_vars"},"required":["uid"]},"statusComponent":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"title":{"description":"Title","type":"string","maxLength":100,"example":"Example Name"},"card_id":{"description":"Card Id","type":"string","maxLength":10,"example":1},"description":{"description":"Description","type":"string","maxLength":1000,"example":"A detailed description of the resource"},"status":{"description":"Status","type":"string","enum":["operational","performance-issues","partial-outage","major-outage"],"nullable":false,"default":"operational","example":"operational"}},"example":{"id":12345,"account_id":1,"title":"Example Name","card_id":1,"description":"A detailed description of the resource","status":"operational"}},"statusComponentInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"title":{"description":"Title","type":"string","maxLength":100,"example":"Example Name"},"card_id":{"description":"Card Id","type":"string","maxLength":10,"example":1},"description":{"description":"Description","type":"string","maxLength":1000,"example":"A detailed description of the resource"},"status":{"description":"Status","type":"string","enum":["operational","performance-issues","partial-outage","major-outage"],"nullable":false,"default":"operational","example":"operational"}},"example":{"id":12345,"account_id":1,"title":"Example Name","card_id":1,"description":"A detailed description of the resource","status":"operational"},"required":["status"]},"statusIncident":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":11,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"created":{"description":"Created","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"updated":{"description":"Updated","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"title":{"description":"Title","type":"string","maxLength":255,"example":"Example Name"},"description":{"description":"Description","type":"string","example":"A detailed description of the resource"},"status":{"description":"Status","type":"string","enum":["fixed","watching","identified","investigating"],"default":"fixed","example":"fixed"},"visibility":{"description":"Visibility","type":"string","enum":["public","private"],"example":"public"}},"example":{"id":12345,"account_id":1,"created":"2025-01-17T10:30:00Z","updated":"2025-01-17T10:30:00Z","title":"Example Name","description":"A detailed description of the resource","status":"fixed","visibility":"public"}},"statusIncidentInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":11,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"created":{"description":"Created","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"updated":{"description":"Updated","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"title":{"description":"Title","type":"string","maxLength":255,"example":"Example Name"},"description":{"description":"Description","type":"string","example":"A detailed description of the resource"},"status":{"description":"Status","type":"string","enum":["fixed","watching","identified","investigating"],"default":"fixed","example":"fixed"},"visibility":{"description":"Visibility","type":"string","enum":["public","private"],"example":"public"}},"example":{"id":12345,"account_id":1,"created":"2025-01-17T10:30:00Z","updated":"2025-01-17T10:30:00Z","title":"Example Name","description":"A detailed description of the resource","status":"fixed","visibility":"public"}},"voicemail":{"type":"object","properties":{}},"weylon":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":4,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"company_id":{"description":"Company Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"criteria":{"description":"Criteria","type":"object","additionalProperties":true,"example":"Sample criteria text content"},"show_output":{"description":"Show Output","type":"integer","nullable":false,"maxLength":255,"minimum":0,"default":"0","example":1}},"example":{"id":12345,"account_id":1,"company_id":1,"name":"Example Name","criteria":"Sample criteria text content","show_output":1}},"weylonInput":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":4,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"company_id":{"description":"Company Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"criteria":{"description":"Criteria","type":"object","additionalProperties":true,"example":"Sample criteria text content"},"show_output":{"description":"Show Output","type":"integer","nullable":false,"maxLength":255,"minimum":0,"default":"0","example":1}},"example":{"id":12345,"account_id":1,"company_id":1,"name":"Example Name","criteria":"Sample criteria text content","show_output":1},"required":["company_id","name","show_output"]},"anycastLoadbalancer":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"ip":{"description":"Ip","type":"string","format":"ipv4","nullable":false,"maxLength":255,"example":"192.168.1.1"},"cost":{"description":"Cost","type":"number","maxLength":10,"example":99.99},"uac_test":{"description":"Uac Test","type":"string","maxLength":100,"default":"19","example":"example_uac_test"},"alg":{"description":"Alg","type":"integer","maxLength":3,"default":"0","example":1},"cps":{"description":"Cps","type":"integer","maxLength":10,"minimum":0,"default":"100","example":123},"created_on":{"description":"Created On","type":"string","format":"date-time","maxLength":6,"example":"2025-01-17T10:30:00Z"},"internal_only":{"description":"Internal Only","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"1","example":1},"validate":{"description":"Validate","type":"string","nullable":false,"maxLength":10,"example":"example_validate"},"compress_in":{"description":"Compress In","type":"string","nullable":false,"maxLength":1000,"example":"example_compress_in"},"compress_out":{"description":"Compress Out","type":"string","nullable":false,"maxLength":1000,"example":"example_compress_out"},"insertion":{"description":"Insertion","type":"string","enum":["stateless","transactional","dialog"],"default":"stateless","example":"stateless"},"flags":{"description":"Flags","type":"string","maxLength":255,"example":"example_flags"},"primary_attempts":{"description":"Primary Attempts","type":"integer","maxLength":3,"minimum":0,"default":"2","example":1},"secondary_attempts":{"description":"Secondary Attempts","type":"integer","maxLength":3,"minimum":0,"default":"2","example":1}},"example":{"id":12345,"account_id":1,"ip":"192.168.1.1","cost":99.99,"uac_test":"example_uac_test","alg":1,"cps":123,"created_on":"2025-01-17T10:30:00Z","internal_only":1,"validate":"example_validate","compress_in":"example_compress_in","compress_out":"example_compress_out","insertion":"stateless","flags":"example_flags","primary_attempts":1,"secondary_attempts":1}},"anycastLoadbalancerInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"ip":{"description":"Ip","type":"string","format":"ipv4","nullable":false,"maxLength":255,"example":"192.168.1.1"},"cost":{"description":"Cost","type":"number","maxLength":10,"example":99.99},"uac_test":{"description":"Uac Test","type":"string","maxLength":100,"default":"19","example":"example_uac_test"},"alg":{"description":"Alg","type":"integer","maxLength":3,"default":"0","example":1},"cps":{"description":"Cps","type":"integer","maxLength":10,"minimum":0,"default":"100","example":123},"created_on":{"description":"Created On","type":"string","format":"date-time","maxLength":6,"example":"2025-01-17T10:30:00Z"},"internal_only":{"description":"Internal Only","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"1","example":1},"validate":{"description":"Validate","type":"string","nullable":false,"maxLength":10,"example":"example_validate"},"compress_in":{"description":"Compress In","type":"string","nullable":false,"maxLength":1000,"example":"example_compress_in"},"compress_out":{"description":"Compress Out","type":"string","nullable":false,"maxLength":1000,"example":"example_compress_out"},"insertion":{"description":"Insertion","type":"string","enum":["stateless","transactional","dialog"],"default":"stateless","example":"stateless"},"flags":{"description":"Flags","type":"string","maxLength":255,"example":"example_flags"},"primary_attempts":{"description":"Primary Attempts","type":"integer","maxLength":3,"minimum":0,"default":"2","example":1},"secondary_attempts":{"description":"Secondary Attempts","type":"integer","maxLength":3,"minimum":0,"default":"2","example":1}},"example":{"id":12345,"account_id":1,"ip":"192.168.1.1","cost":99.99,"uac_test":"example_uac_test","alg":1,"cps":123,"created_on":"2025-01-17T10:30:00Z","internal_only":1,"validate":"example_validate","compress_in":"example_compress_in","compress_out":"example_compress_out","insertion":"stateless","flags":"example_flags","primary_attempts":1,"secondary_attempts":1},"required":["ip","internal_only","validate","compress_in","compress_out"]},"setupApi":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"type":{"description":"Type","type":"string","maxLength":50,"example":"example_type"},"mode":{"description":"Mode","type":"string","enum":["sandbox","live","dev","test"],"nullable":false,"example":"sandbox"},"email":{"description":"Email","type":"string","format":"email","maxLength":255,"example":"user@example.com"},"host":{"description":"Host","type":"string","maxLength":255,"example":"example_host"},"username":{"description":"Username","type":"string","maxLength":255,"example":"john_doe"},"password":{"description":"Password","type":"string","format":"password","maxLength":255,"example":"********"},"signature":{"description":"Signature","type":"string","example":"Sample signature text content"},"api_id":{"description":"Api Id","type":"integer","maxLength":11,"example":1},"public_key":{"description":"Public Key","type":"string","maxLength":255,"example":"example_public_key"},"private_key":{"description":"Private Key","type":"string","maxLength":255,"example":"example_private_key"},"key1":{"description":"Key 1","type":"string","nullable":false,"maxLength":255,"example":"example_key1"},"key2":{"description":"Key 2","type":"string","nullable":false,"maxLength":255,"example":"example_key2"},"key3":{"description":"Key 3","type":"string","nullable":false,"maxLength":255,"example":"example_key3"},"key4":{"description":"Key 4","type":"string","nullable":false,"maxLength":255,"example":"example_key4"},"currency":{"description":"Currency","type":"string","maxLength":255,"example":"USD"},"verify_transaction":{"description":"Verify Transaction","type":"integer","maxLength":4,"example":1},"payment_types":{"description":"Payment Types","type":"string","maxLength":255,"example":"example_payment_types"},"company_id":{"description":"Company Id","type":"integer","maxLength":10,"minimum":0,"example":1},"sandbox_id":{"description":"Sandbox Id","type":"integer","maxLength":10,"minimum":0,"example":1},"deduct_payment_fees":{"description":"Deduct Payment Fees","type":"integer","maxLength":255,"minimum":0,"default":"1","example":1},"surcharge":{"description":"Surcharge","type":"number","nullable":false,"maxLength":8,"default":"0","example":99.99},"surcharge_percent":{"description":"Surcharge Percent","type":"number","nullable":false,"maxLength":8,"default":"0","example":1.5}},"example":{"id":12345,"account_id":1,"type":"example_type","mode":"sandbox","email":"user@example.com","host":"example_host","username":"john_doe","password":"********","signature":"Sample signature text content","api_id":1,"public_key":"example_public_key","private_key":"example_private_key","key1":"example_key1","key2":"example_key2","key3":"example_key3","key4":"example_key4","currency":"USD","verify_transaction":1,"payment_types":"example_payment_types","company_id":1,"sandbox_id":1,"deduct_payment_fees":1,"surcharge":99.99,"surcharge_percent":1.5}},"setupApiInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"type":{"description":"Type","type":"string","maxLength":50,"example":"example_type"},"mode":{"description":"Mode","type":"string","enum":["sandbox","live","dev","test"],"nullable":false,"example":"sandbox"},"email":{"description":"Email","type":"string","format":"email","maxLength":255,"example":"user@example.com"},"host":{"description":"Host","type":"string","maxLength":255,"example":"example_host"},"username":{"description":"Username","type":"string","maxLength":255,"example":"john_doe"},"password":{"description":"Password","type":"string","format":"password","maxLength":255,"example":"********"},"signature":{"description":"Signature","type":"string","example":"Sample signature text content"},"api_id":{"description":"Api Id","type":"integer","maxLength":11,"example":1},"public_key":{"description":"Public Key","type":"string","maxLength":255,"example":"example_public_key"},"private_key":{"description":"Private Key","type":"string","maxLength":255,"example":"example_private_key"},"key1":{"description":"Key 1","type":"string","nullable":false,"maxLength":255,"example":"example_key1"},"key2":{"description":"Key 2","type":"string","nullable":false,"maxLength":255,"example":"example_key2"},"key3":{"description":"Key 3","type":"string","nullable":false,"maxLength":255,"example":"example_key3"},"key4":{"description":"Key 4","type":"string","nullable":false,"maxLength":255,"example":"example_key4"},"currency":{"description":"Currency","type":"string","maxLength":255,"example":"USD"},"verify_transaction":{"description":"Verify Transaction","type":"integer","maxLength":4,"example":1},"payment_types":{"description":"Payment Types","type":"string","maxLength":255,"example":"example_payment_types"},"company_id":{"description":"Company Id","type":"integer","maxLength":10,"minimum":0,"example":1},"sandbox_id":{"description":"Sandbox Id","type":"integer","maxLength":10,"minimum":0,"example":1},"deduct_payment_fees":{"description":"Deduct Payment Fees","type":"integer","maxLength":255,"minimum":0,"default":"1","example":1},"surcharge":{"description":"Surcharge","type":"number","nullable":false,"maxLength":8,"default":"0","example":99.99},"surcharge_percent":{"description":"Surcharge Percent","type":"number","nullable":false,"maxLength":8,"default":"0","example":1.5}},"example":{"id":12345,"account_id":1,"type":"example_type","mode":"sandbox","email":"user@example.com","host":"example_host","username":"john_doe","password":"********","signature":"Sample signature text content","api_id":1,"public_key":"example_public_key","private_key":"example_private_key","key1":"example_key1","key2":"example_key2","key3":"example_key3","key4":"example_key4","currency":"USD","verify_transaction":1,"payment_types":"example_payment_types","company_id":1,"sandbox_id":1,"deduct_payment_fees":1,"surcharge":99.99,"surcharge_percent":1.5},"required":["mode","key1","key2","key3","key4","surcharge","surcharge_percent"]},"setupApp":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":40,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"repo_id":{"description":"Repo Id","type":"string","maxLength":40,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"version":{"description":"Version","type":"string","maxLength":50,"example":"example_version"},"domain":{"description":"Domain","type":"string","maxLength":255,"example":"example_domain"},"company_id":{"description":"Company Id","type":"integer","maxLength":10,"minimum":0,"example":1},"framework_version":{"description":"Framework Version","type":"string","maxLength":255,"default":"latest","example":"example_framework_version"},"icon":{"description":"Icon","type":"string","maxLength":255,"example":"example_icon"},"anvil_mcp_api_key":{"description":"Anvil Mcp Api Key","type":"string","maxLength":255,"example":"example_anvil_mcp_api_key"}},"example":{"id":12345,"account_id":1,"repo_id":1,"name":"Example Name","version":"example_version","domain":"example_domain","company_id":1,"framework_version":"example_framework_version","icon":"example_icon","anvil_mcp_api_key":"example_anvil_mcp_api_key"}},"setupAppInput":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":40,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"repo_id":{"description":"Repo Id","type":"string","maxLength":40,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"version":{"description":"Version","type":"string","maxLength":50,"example":"example_version"},"domain":{"description":"Domain","type":"string","maxLength":255,"example":"example_domain"},"company_id":{"description":"Company Id","type":"integer","maxLength":10,"minimum":0,"example":1},"framework_version":{"description":"Framework Version","type":"string","maxLength":255,"default":"latest","example":"example_framework_version"},"icon":{"description":"Icon","type":"string","maxLength":255,"example":"example_icon"},"anvil_mcp_api_key":{"description":"Anvil Mcp Api Key","type":"string","maxLength":255,"example":"example_anvil_mcp_api_key"}},"example":{"id":12345,"account_id":1,"repo_id":1,"name":"Example Name","version":"example_version","domain":"example_domain","company_id":1,"framework_version":"example_framework_version","icon":"example_icon","anvil_mcp_api_key":"example_anvil_mcp_api_key"},"required":["name"]},"setupAudit":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"user_id":{"description":"User Id","type":"integer","maxLength":10,"minimum":0,"example":1},"contact_id":{"description":"Contact Id","type":"integer","maxLength":11,"example":1},"ip":{"description":"Ip","type":"string","format":"ipv4","maxLength":40,"example":"192.168.1.1"},"dt":{"description":"Dt","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"pk":{"description":"Pk","type":"string","maxLength":300,"example":"example_pk"},"action":{"description":"Action","type":"string","nullable":false,"maxLength":10,"example":"example_action"},"table":{"description":"Table","type":"string","nullable":false,"maxLength":50,"example":"example_table"},"msg":{"description":"Msg","type":"string","maxLength":100,"example":"example_msg"},"data":{"description":"Data","type":"string","example":"Sample data text content"}},"example":{"id":12345,"account_id":1,"user_id":1,"contact_id":1,"ip":"192.168.1.1","dt":"2025-01-17T10:30:00Z","pk":"example_pk","action":"example_action","table":"example_table","msg":"example_msg","data":"Sample data text content"}},"setupButton":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":11,"example":1},"company_id":{"description":"Company Id","type":"integer","maxLength":10,"minimum":0,"example":1},"app_id":{"description":"App Id","type":"string","maxLength":40,"example":1},"anvil_path":{"description":"Anvil Path","type":"string","maxLength":255,"example":"example_anvil_path"},"label":{"description":"Label","type":"string","maxLength":255,"example":"example_label"},"icon":{"description":"Icon","type":"string","maxLength":255,"example":"example_icon"},"tooltip":{"description":"Tooltip","type":"string","maxLength":500,"example":"example_tooltip"},"type":{"description":"Type","type":"string","maxLength":30,"example":"example_type"},"area":{"description":"Area","type":"string","maxLength":255,"default":"cp","example":"example_area"},"placement":{"description":"Placement","type":"string","maxLength":255,"example":"example_placement"},"min_select":{"description":"Min Select","type":"integer","maxLength":255,"minimum":0,"example":123},"max_select":{"description":"Max Select","type":"integer","maxLength":255,"minimum":0,"example":123},"sandbox_id":{"description":"Sandbox Id","type":"integer","maxLength":10,"minimum":0,"example":1},"fn":{"description":"Fn","type":"string","maxLength":255,"default":"main","example":"example_fn"},"form_id":{"description":"Form Id","type":"integer","maxLength":10,"minimum":0,"example":1},"page_id":{"description":"Page Id","type":"string","maxLength":40,"example":1},"sort_order":{"description":"Sort Order","type":"integer","maxLength":255,"minimum":0,"default":"50","example":1},"company_ids":{"description":"Company Ids","type":"string","maxLength":5000,"example":"example_company_ids"},"open_mode":{"description":"Open Mode","type":"string","enum":["page","dialog"],"example":"page"}},"example":{"id":12345,"account_id":1,"company_id":1,"app_id":1,"anvil_path":"example_anvil_path","label":"example_label","icon":"example_icon","tooltip":"example_tooltip","type":"example_type","area":"example_area","placement":"example_placement","min_select":123,"max_select":123,"sandbox_id":1,"fn":"example_fn","form_id":1,"page_id":1,"sort_order":1,"company_ids":"example_company_ids","open_mode":"page"}},"setupButtonInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":11,"example":1},"company_id":{"description":"Company Id","type":"integer","maxLength":10,"minimum":0,"example":1},"app_id":{"description":"App Id","type":"string","maxLength":40,"example":1},"anvil_path":{"description":"Anvil Path","type":"string","maxLength":255,"example":"example_anvil_path"},"label":{"description":"Label","type":"string","maxLength":255,"example":"example_label"},"icon":{"description":"Icon","type":"string","maxLength":255,"example":"example_icon"},"tooltip":{"description":"Tooltip","type":"string","maxLength":500,"example":"example_tooltip"},"type":{"description":"Type","type":"string","maxLength":30,"example":"example_type"},"area":{"description":"Area","type":"string","maxLength":255,"default":"cp","example":"example_area"},"placement":{"description":"Placement","type":"string","maxLength":255,"example":"example_placement"},"min_select":{"description":"Min Select","type":"integer","maxLength":255,"minimum":0,"example":123},"max_select":{"description":"Max Select","type":"integer","maxLength":255,"minimum":0,"example":123},"sandbox_id":{"description":"Sandbox Id","type":"integer","maxLength":10,"minimum":0,"example":1},"fn":{"description":"Fn","type":"string","maxLength":255,"default":"main","example":"example_fn"},"form_id":{"description":"Form Id","type":"integer","maxLength":10,"minimum":0,"example":1},"page_id":{"description":"Page Id","type":"string","maxLength":40,"example":1},"sort_order":{"description":"Sort Order","type":"integer","maxLength":255,"minimum":0,"default":"50","example":1},"company_ids":{"description":"Company Ids","type":"string","maxLength":5000,"example":"example_company_ids"},"open_mode":{"description":"Open Mode","type":"string","enum":["page","dialog"],"example":"page"}},"example":{"id":12345,"account_id":1,"company_id":1,"app_id":1,"anvil_path":"example_anvil_path","label":"example_label","icon":"example_icon","tooltip":"example_tooltip","type":"example_type","area":"example_area","placement":"example_placement","min_select":123,"max_select":123,"sandbox_id":1,"fn":"example_fn","form_id":1,"page_id":1,"sort_order":1,"company_ids":"example_company_ids","open_mode":"page"}},"setupCert":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":11,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"domain":{"description":"Domain (unique)","type":"string","maxLength":255,"x-unique":true,"example":"example_domain"},"cert":{"description":"Cert","type":"string","example":"Sample cert text content"},"key":{"description":"Key","type":"string","example":"Sample key text content"},"ca_cert":{"description":"Ca Cert","type":"string","example":"Sample ca_cert text content"},"deployed":{"description":"Deployed","type":"integer","nullable":false,"maxLength":1,"minimum":0,"default":"0","example":1},"user_provided":{"description":"User Provided","type":"integer","nullable":false,"maxLength":1,"minimum":0,"default":"0","example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"valid_from":{"description":"Valid From","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"valid_to":{"description":"Valid To","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"subject_cn":{"description":"Subject Cn","type":"string","maxLength":255,"example":"example_subject_cn"}},"example":{"id":12345,"account_id":1,"domain":"example_domain","cert":"Sample cert text content","key":"Sample key text content","ca_cert":"Sample ca_cert text content","deployed":1,"user_provided":1,"name":"Example Name","valid_from":"2025-01-17T10:30:00Z","valid_to":"2025-01-17T10:30:00Z","subject_cn":"example_subject_cn"}},"setupCertInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":11,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"domain":{"description":"Domain (unique)","type":"string","maxLength":255,"x-unique":true,"example":"example_domain"},"cert":{"description":"Cert","type":"string","example":"Sample cert text content"},"key":{"description":"Key","type":"string","example":"Sample key text content"},"ca_cert":{"description":"Ca Cert","type":"string","example":"Sample ca_cert text content"},"deployed":{"description":"Deployed","type":"integer","nullable":false,"maxLength":1,"minimum":0,"default":"0","example":1},"user_provided":{"description":"User Provided","type":"integer","nullable":false,"maxLength":1,"minimum":0,"default":"0","example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"valid_from":{"description":"Valid From","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"valid_to":{"description":"Valid To","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"subject_cn":{"description":"Subject Cn","type":"string","maxLength":255,"example":"example_subject_cn"}},"example":{"id":12345,"account_id":1,"domain":"example_domain","cert":"Sample cert text content","key":"Sample key text content","ca_cert":"Sample ca_cert text content","deployed":1,"user_provided":1,"name":"Example Name","valid_from":"2025-01-17T10:30:00Z","valid_to":"2025-01-17T10:30:00Z","subject_cn":"example_subject_cn"},"required":["deployed","user_provided","name"]},"setupCluster":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"}},"example":{"id":12345,"account_id":1,"name":"Example Name"}},"setupClusterInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"}},"example":{"id":12345,"account_id":1,"name":"Example Name"},"required":["name"]},"setupComponent":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"path":{"description":"Path","type":"string","maxLength":255,"example":"example_path"},"section":{"description":"Section","type":"string","maxLength":255,"example":"example_section"},"title":{"description":"Title","type":"string","maxLength":255,"example":"Example Name"},"subtitle":{"description":"Subtitle","type":"string","nullable":false,"maxLength":255,"example":"example_subtitle"},"graph_type":{"description":"Graph Type","type":"string","enum":["line","area","bar","pie","radar","sankey","gauge"],"example":"line"},"colspan":{"description":"Colspan","type":"integer","maxLength":255,"minimum":0,"example":1},"height":{"description":"Height","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"300","example":123},"output":{"description":"Output","type":"array","items":{"type":"string","enum":["graph","table","download","html","debug","vue"]},"default":"debug","example":"graph"},"queries":{"description":"Queries","type":"string","maxLength":255,"example":"example_queries"},"graph":{"description":"Graph","type":"object","additionalProperties":true,"example":"Sample graph text content"},"scriptforge_id":{"description":"Scriptforge Id","type":"integer","maxLength":255,"minimum":0,"example":1},"analytic_id":{"description":"Analytic Id","type":"integer","maxLength":10,"minimum":0,"example":1},"pre_processor_script":{"description":"Pre Processor Script","type":"string","example":"Sample pre_processor_script text content"}},"example":{"id":12345,"account_id":1,"name":"Example Name","path":"example_path","section":"example_section","title":"Example Name","subtitle":"example_subtitle","graph_type":"line","colspan":1,"height":123,"output":"graph","queries":"example_queries","graph":"Sample graph text content","scriptforge_id":1,"analytic_id":1,"pre_processor_script":"Sample pre_processor_script text content"}},"setupComponentInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"path":{"description":"Path","type":"string","maxLength":255,"example":"example_path"},"section":{"description":"Section","type":"string","maxLength":255,"example":"example_section"},"title":{"description":"Title","type":"string","maxLength":255,"example":"Example Name"},"subtitle":{"description":"Subtitle","type":"string","nullable":false,"maxLength":255,"example":"example_subtitle"},"graph_type":{"description":"Graph Type","type":"string","enum":["line","area","bar","pie","radar","sankey","gauge"],"example":"line"},"colspan":{"description":"Colspan","type":"integer","maxLength":255,"minimum":0,"example":1},"height":{"description":"Height","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"300","example":123},"output":{"description":"Output","type":"array","items":{"type":"string","enum":["graph","table","download","html","debug","vue"]},"default":"debug","example":"graph"},"queries":{"description":"Queries","type":"string","maxLength":255,"example":"example_queries"},"graph":{"description":"Graph","type":"object","additionalProperties":true,"example":"Sample graph text content"},"scriptforge_id":{"description":"Scriptforge Id","type":"integer","maxLength":255,"minimum":0,"example":1},"analytic_id":{"description":"Analytic Id","type":"integer","maxLength":10,"minimum":0,"example":1},"pre_processor_script":{"description":"Pre Processor Script","type":"string","example":"Sample pre_processor_script text content"}},"example":{"id":12345,"account_id":1,"name":"Example Name","path":"example_path","section":"example_section","title":"Example Name","subtitle":"example_subtitle","graph_type":"line","colspan":1,"height":123,"output":"graph","queries":"example_queries","graph":"Sample graph text content","scriptforge_id":1,"analytic_id":1,"pre_processor_script":"Sample pre_processor_script text content"},"required":["name","subtitle","height"]},"setupContract":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"name":{"description":"Name","type":"string","nullable":false,"maxLength":100,"example":"Example Name"},"default":{"description":"Default","type":"integer","nullable":false,"maxLength":3,"minimum":0,"example":1},"deleted":{"description":"Deleted","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"kyc":{"description":"Kyc","type":"integer","nullable":false,"maxLength":1,"minimum":0,"default":"0","example":1}},"example":{"id":12345,"account_id":1,"name":"Example Name","default":1,"deleted":1,"kyc":1}},"setupContractInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"name":{"description":"Name","type":"string","nullable":false,"maxLength":100,"example":"Example Name"},"default":{"description":"Default","type":"integer","nullable":false,"maxLength":3,"minimum":0,"example":1},"deleted":{"description":"Deleted","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"kyc":{"description":"Kyc","type":"integer","nullable":false,"maxLength":1,"minimum":0,"default":"0","example":1}},"example":{"id":12345,"account_id":1,"name":"Example Name","default":1,"deleted":1,"kyc":1},"required":["name","default","deleted","kyc"]},"setupDocument":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"dt":{"description":"Dt","type":"string","format":"date-time","maxLength":6,"example":"2025-01-17T10:30:00Z"},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"notes":{"description":"Notes","type":"string","example":"Sample notes text content"},"account_notes":{"description":"Account Notes","type":"string","example":10},"filename":{"description":"Filename","type":"string","maxLength":255,"example":"example_filename"}},"example":{"id":12345,"account_id":1,"dt":"2025-01-17T10:30:00Z","name":"Example Name","notes":"Sample notes text content","account_notes":10,"filename":"example_filename"}},"setupDocumentInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"dt":{"description":"Dt","type":"string","format":"date-time","maxLength":6,"example":"2025-01-17T10:30:00Z"},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"notes":{"description":"Notes","type":"string","example":"Sample notes text content"},"account_notes":{"description":"Account Notes","type":"string","example":10},"filename":{"description":"Filename","type":"string","maxLength":255,"example":"example_filename"}},"example":{"id":12345,"account_id":1,"dt":"2025-01-17T10:30:00Z","name":"Example Name","notes":"Sample notes text content","account_notes":10,"filename":"example_filename"},"required":["name"]},"setupCxPackages":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"cx_package_id":{"description":"Cx Package Id (references cx_package.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"cx_package","referencesColumn":"id"},"example":1},"qty":{"description":"Qty","type":"integer","maxLength":10,"minimum":0,"example":123},"max_daily_qty":{"description":"Max Daily Qty","type":"integer","maxLength":10,"minimum":0,"example":123}},"example":{"id":12345,"account_id":1,"cx_package_id":1,"qty":123,"max_daily_qty":123}},"setupCxPackagesInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"cx_package_id":{"description":"Cx Package Id (references cx_package.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"cx_package","referencesColumn":"id"},"example":1},"qty":{"description":"Qty","type":"integer","maxLength":10,"minimum":0,"example":123},"max_daily_qty":{"description":"Max Daily Qty","type":"integer","maxLength":10,"minimum":0,"example":123}},"example":{"id":12345,"account_id":1,"cx_package_id":1,"qty":123,"max_daily_qty":123},"required":["cx_package_id"]},"setupDatastore":{"type":"object","properties":{}},"setupDatastoreInput":{"type":"object","properties":{}},"setupDns":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":1},"domain":{"description":"Domain (unique)","type":"string","nullable":false,"maxLength":255,"x-unique":true,"example":"example_domain"},"a":{"description":"A","type":"string","nullable":false,"maxLength":255,"example":"example_a"},"srv_t1":{"description":"Srv T 1","type":"string","nullable":false,"maxLength":255,"default":"{}","example":"example_srv_t1"},"srv_t2":{"description":"Srv T 2","type":"string","nullable":false,"maxLength":255,"default":"{}","example":"example_srv_t2"},"srv_t3":{"description":"Srv T 3","type":"string","nullable":false,"maxLength":255,"default":"{}","example":"example_srv_t3"},"ttl":{"description":"Ttl","type":"integer","maxLength":255,"minimum":0,"default":"60","example":123},"srv_t1_anyedge_mirror":{"description":"Srv T 1 Anyedge Mirror","type":"integer","maxLength":255,"minimum":0,"example":123},"srv_t2_anyedge_mirror":{"description":"Srv T 2 Anyedge Mirror","type":"integer","maxLength":255,"minimum":0,"example":123},"srv_t3_anyedge_mirror":{"description":"Srv T 3 Anyedge Mirror","type":"integer","maxLength":255,"minimum":0,"example":123}},"example":{"id":12345,"account_id":1,"domain":"example_domain","a":"example_a","srv_t1":"example_srv_t1","srv_t2":"example_srv_t2","srv_t3":"example_srv_t3","ttl":123,"srv_t1_anyedge_mirror":123,"srv_t2_anyedge_mirror":123,"srv_t3_anyedge_mirror":123}},"setupDnsInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":1},"domain":{"description":"Domain (unique)","type":"string","nullable":false,"maxLength":255,"x-unique":true,"example":"example_domain"},"a":{"description":"A","type":"string","nullable":false,"maxLength":255,"example":"example_a"},"srv_t1":{"description":"Srv T 1","type":"string","nullable":false,"maxLength":255,"default":"{}","example":"example_srv_t1"},"srv_t2":{"description":"Srv T 2","type":"string","nullable":false,"maxLength":255,"default":"{}","example":"example_srv_t2"},"srv_t3":{"description":"Srv T 3","type":"string","nullable":false,"maxLength":255,"default":"{}","example":"example_srv_t3"},"ttl":{"description":"Ttl","type":"integer","maxLength":255,"minimum":0,"default":"60","example":123},"srv_t1_anyedge_mirror":{"description":"Srv T 1 Anyedge Mirror","type":"integer","maxLength":255,"minimum":0,"example":123},"srv_t2_anyedge_mirror":{"description":"Srv T 2 Anyedge Mirror","type":"integer","maxLength":255,"minimum":0,"example":123},"srv_t3_anyedge_mirror":{"description":"Srv T 3 Anyedge Mirror","type":"integer","maxLength":255,"minimum":0,"example":123}},"example":{"id":12345,"account_id":1,"domain":"example_domain","a":"example_a","srv_t1":"example_srv_t1","srv_t2":"example_srv_t2","srv_t3":"example_srv_t3","ttl":123,"srv_t1_anyedge_mirror":123,"srv_t2_anyedge_mirror":123,"srv_t3_anyedge_mirror":123},"required":["domain","a","srv_t1","srv_t2","srv_t3"]},"setupDomain":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"domain":{"description":"Domain (unique)","type":"string","nullable":false,"maxLength":255,"x-unique":true,"example":"example_domain"},"brand_name":{"description":"Brand Name","type":"string","maxLength":255,"example":"example_brand_name"},"managed":{"description":"Managed","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"1","example":1},"type":{"description":"Type","type":"string","enum":["portal","server"],"nullable":false,"default":"portal","example":"portal"},"landing_page":{"description":"Landing Page","type":"string","maxLength":255,"default":"/portal","example":"example_landing_page"},"access":{"description":"Access","type":"string","maxLength":1000,"example":"example_access"},"feature":{"description":"Feature","type":"string","maxLength":255,"example":"example_feature"},"prop":{"description":"Prop","type":"array","items":{"type":"string","enum":[""]},"default":"","example":"value"},"carrier_signup":{"description":"Carrier Signup","type":"integer","maxLength":3,"minimum":0,"default":"0","example":1},"customer_signup":{"description":"Customer Signup","type":"integer","maxLength":3,"minimum":0,"default":"0","example":1},"new_customer_defaults":{"description":"New Customer Defaults","type":"string","maxLength":500,"example":"example_new_customer_defaults"},"new_customer_debit_limit":{"description":"New Customer Debit Limit","type":"number","maxLength":8,"example":99.99},"new_customer_status":{"description":"New Customer Status","type":"string","maxLength":20,"example":"example_new_customer_status"},"ssl_certificate":{"description":"Ssl Certificate","type":"string","example":"Sample ssl_certificate text content"},"ssl_certificate_key":{"description":"Ssl Certificate Key","type":"string","example":"Sample ssl_certificate_key text content"},"ssl_ca_certificate":{"description":"Ssl Ca Certificate","type":"string","example":"Sample ssl_ca_certificate text content"},"ssl_cert_request_hash_a":{"description":"Ssl Cert Request Hash A","type":"string","maxLength":1000,"example":"example_ssl_cert_request_hash_a"},"ssl_cert_request_hash_b":{"description":"Ssl Cert Request Hash B","type":"string","maxLength":1000,"example":"example_ssl_cert_request_hash_b"},"a":{"description":"A","type":"string","maxLength":255,"example":"example_a"},"srv":{"description":"Srv","type":"object","additionalProperties":true,"maxLength":1000,"example":"example_srv"},"ttl":{"description":"Ttl","type":"integer","maxLength":10,"minimum":0,"default":"60","example":123},"template_customer_id":{"description":"Template Customer Id","type":"integer","maxLength":10,"minimum":0,"example":1},"javascript":{"description":"Javascript","type":"string","example":"Sample javascript text content"},"css":{"description":"Css","type":"string","example":"Sample css text content"},"currencies":{"description":"Currencies","type":"string","maxLength":255,"default":"usd,gbp,eur","example":"example_currencies"},"cdr_fields":{"description":"Cdr Fields","type":"string","maxLength":1000,"example":"example_cdr_fields"},"breakout_fields":{"description":"Breakout Fields","type":"string","maxLength":1000,"example":"example_breakout_fields"},"logo":{"description":"Logo","type":"string","maxLength":255,"example":"example_logo"},"footer":{"description":"Footer","type":"string","maxLength":1000,"example":"example_footer"},"softphone_deploy_type":{"description":"Softphone Deploy Type","type":"string","enum":["code","sms","existing"],"example":"code"},"softphone_signup_fields":{"description":"Softphone Signup Fields","type":"string","maxLength":255,"example":"example_softphone_signup_fields"},"softphone_menu":{"description":"Softphone Menu","type":"object","additionalProperties":true,"example":"Sample softphone_menu text content"},"softphone_register_success_html":{"description":"Softphone Register Success Html","type":"string","maxLength":255,"example":"example_softphone_register_success_html"},"softphone_host":{"description":"Softphone Host","type":"string","maxLength":255,"example":"example_softphone_host"},"softphone_flags":{"description":"Softphone Flags","type":"array","items":{"type":"string","enum":["BALANCE","HIDE_UUID","SIMPLE_ERRORS","MENU_RIGHT","EDIT_SETTINGS"]},"default":"","example":"BALANCE"},"smtp_server":{"description":"Smtp Server","type":"string","maxLength":255,"example":"example_smtp_server"},"smtp_username":{"description":"Smtp Username","type":"string","maxLength":255,"example":"example_smtp_username"},"smtp_password":{"description":"Smtp Password","type":"string","format":"password","maxLength":255,"example":"example_smtp_password"},"smtp_from_address":{"description":"Smtp From Address","type":"string","maxLength":255,"example":"example_smtp_from_address"},"flags":{"description":"Flags","type":"string","maxLength":255,"example":"example_flags"}},"example":{"id":12345,"account_id":1,"domain":"example_domain","brand_name":"example_brand_name","managed":1,"type":"portal","landing_page":"example_landing_page","access":"example_access","feature":"example_feature","prop":"value","carrier_signup":1,"customer_signup":1,"new_customer_defaults":"example_new_customer_defaults","new_customer_debit_limit":99.99,"new_customer_status":"example_new_customer_status","ssl_certificate":"Sample ssl_certificate text content","ssl_certificate_key":"Sample ssl_certificate_key text content","ssl_ca_certificate":"Sample ssl_ca_certificate text content","ssl_cert_request_hash_a":"example_ssl_cert_request_hash_a","ssl_cert_request_hash_b":"example_ssl_cert_request_hash_b","a":"example_a","srv":"example_srv","ttl":123,"template_customer_id":1,"javascript":"Sample javascript text content","css":"Sample css text content","currencies":"example_currencies","cdr_fields":"example_cdr_fields","breakout_fields":"example_breakout_fields","logo":"example_logo","footer":"example_footer","softphone_deploy_type":"code","softphone_signup_fields":"example_softphone_signup_fields","softphone_menu":"Sample softphone_menu text content","softphone_register_success_html":"example_softphone_register_success_html","softphone_host":"example_softphone_host","softphone_flags":"BALANCE","smtp_server":"example_smtp_server","smtp_username":"example_smtp_username","smtp_password":"example_smtp_password","smtp_from_address":"example_smtp_from_address","flags":"example_flags"}},"setupDomainInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"domain":{"description":"Domain (unique)","type":"string","nullable":false,"maxLength":255,"x-unique":true,"example":"example_domain"},"brand_name":{"description":"Brand Name","type":"string","maxLength":255,"example":"example_brand_name"},"managed":{"description":"Managed","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"1","example":1},"type":{"description":"Type","type":"string","enum":["portal","server"],"nullable":false,"default":"portal","example":"portal"},"landing_page":{"description":"Landing Page","type":"string","maxLength":255,"default":"/portal","example":"example_landing_page"},"access":{"description":"Access","type":"string","maxLength":1000,"example":"example_access"},"feature":{"description":"Feature","type":"string","maxLength":255,"example":"example_feature"},"prop":{"description":"Prop","type":"array","items":{"type":"string","enum":[""]},"default":"","example":"value"},"carrier_signup":{"description":"Carrier Signup","type":"integer","maxLength":3,"minimum":0,"default":"0","example":1},"customer_signup":{"description":"Customer Signup","type":"integer","maxLength":3,"minimum":0,"default":"0","example":1},"new_customer_defaults":{"description":"New Customer Defaults","type":"string","maxLength":500,"example":"example_new_customer_defaults"},"new_customer_debit_limit":{"description":"New Customer Debit Limit","type":"number","maxLength":8,"example":99.99},"new_customer_status":{"description":"New Customer Status","type":"string","maxLength":20,"example":"example_new_customer_status"},"ssl_certificate":{"description":"Ssl Certificate","type":"string","example":"Sample ssl_certificate text content"},"ssl_certificate_key":{"description":"Ssl Certificate Key","type":"string","example":"Sample ssl_certificate_key text content"},"ssl_ca_certificate":{"description":"Ssl Ca Certificate","type":"string","example":"Sample ssl_ca_certificate text content"},"ssl_cert_request_hash_a":{"description":"Ssl Cert Request Hash A","type":"string","maxLength":1000,"example":"example_ssl_cert_request_hash_a"},"ssl_cert_request_hash_b":{"description":"Ssl Cert Request Hash B","type":"string","maxLength":1000,"example":"example_ssl_cert_request_hash_b"},"a":{"description":"A","type":"string","maxLength":255,"example":"example_a"},"srv":{"description":"Srv","type":"object","additionalProperties":true,"maxLength":1000,"example":"example_srv"},"ttl":{"description":"Ttl","type":"integer","maxLength":10,"minimum":0,"default":"60","example":123},"template_customer_id":{"description":"Template Customer Id","type":"integer","maxLength":10,"minimum":0,"example":1},"javascript":{"description":"Javascript","type":"string","example":"Sample javascript text content"},"css":{"description":"Css","type":"string","example":"Sample css text content"},"currencies":{"description":"Currencies","type":"string","maxLength":255,"default":"usd,gbp,eur","example":"example_currencies"},"cdr_fields":{"description":"Cdr Fields","type":"string","maxLength":1000,"example":"example_cdr_fields"},"breakout_fields":{"description":"Breakout Fields","type":"string","maxLength":1000,"example":"example_breakout_fields"},"logo":{"description":"Logo","type":"string","maxLength":255,"example":"example_logo"},"footer":{"description":"Footer","type":"string","maxLength":1000,"example":"example_footer"},"softphone_deploy_type":{"description":"Softphone Deploy Type","type":"string","enum":["code","sms","existing"],"example":"code"},"softphone_signup_fields":{"description":"Softphone Signup Fields","type":"string","maxLength":255,"example":"example_softphone_signup_fields"},"softphone_menu":{"description":"Softphone Menu","type":"object","additionalProperties":true,"example":"Sample softphone_menu text content"},"softphone_register_success_html":{"description":"Softphone Register Success Html","type":"string","maxLength":255,"example":"example_softphone_register_success_html"},"softphone_host":{"description":"Softphone Host","type":"string","maxLength":255,"example":"example_softphone_host"},"softphone_flags":{"description":"Softphone Flags","type":"array","items":{"type":"string","enum":["BALANCE","HIDE_UUID","SIMPLE_ERRORS","MENU_RIGHT","EDIT_SETTINGS"]},"default":"","example":"BALANCE"},"smtp_server":{"description":"Smtp Server","type":"string","maxLength":255,"example":"example_smtp_server"},"smtp_username":{"description":"Smtp Username","type":"string","maxLength":255,"example":"example_smtp_username"},"smtp_password":{"description":"Smtp Password","type":"string","format":"password","maxLength":255,"example":"example_smtp_password"},"smtp_from_address":{"description":"Smtp From Address","type":"string","maxLength":255,"example":"example_smtp_from_address"},"flags":{"description":"Flags","type":"string","maxLength":255,"example":"example_flags"}},"example":{"id":12345,"account_id":1,"domain":"example_domain","brand_name":"example_brand_name","managed":1,"type":"portal","landing_page":"example_landing_page","access":"example_access","feature":"example_feature","prop":"value","carrier_signup":1,"customer_signup":1,"new_customer_defaults":"example_new_customer_defaults","new_customer_debit_limit":99.99,"new_customer_status":"example_new_customer_status","ssl_certificate":"Sample ssl_certificate text content","ssl_certificate_key":"Sample ssl_certificate_key text content","ssl_ca_certificate":"Sample ssl_ca_certificate text content","ssl_cert_request_hash_a":"example_ssl_cert_request_hash_a","ssl_cert_request_hash_b":"example_ssl_cert_request_hash_b","a":"example_a","srv":"example_srv","ttl":123,"template_customer_id":1,"javascript":"Sample javascript text content","css":"Sample css text content","currencies":"example_currencies","cdr_fields":"example_cdr_fields","breakout_fields":"example_breakout_fields","logo":"example_logo","footer":"example_footer","softphone_deploy_type":"code","softphone_signup_fields":"example_softphone_signup_fields","softphone_menu":"Sample softphone_menu text content","softphone_register_success_html":"example_softphone_register_success_html","softphone_host":"example_softphone_host","softphone_flags":"BALANCE","smtp_server":"example_smtp_server","smtp_username":"example_smtp_username","smtp_password":"example_smtp_password","smtp_from_address":"example_smtp_from_address","flags":"example_flags"},"required":["domain","managed","type"]},"setupFirewall":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":255,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"dt":{"description":"Dt","type":"string","format":"date-time","default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"ip":{"description":"Ip","type":"string","format":"ipv4","maxLength":255,"example":"192.168.1.1"},"action":{"description":"Action","type":"string","enum":["block"],"example":"block"},"notes":{"description":"Notes","type":"string","maxLength":1000,"example":"example_notes"}},"example":{"id":12345,"account_id":1,"dt":"2025-01-17T10:30:00Z","ip":"192.168.1.1","action":"block","notes":"example_notes"}},"setupFirewallInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":255,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"dt":{"description":"Dt","type":"string","format":"date-time","default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"ip":{"description":"Ip","type":"string","format":"ipv4","maxLength":255,"example":"192.168.1.1"},"action":{"description":"Action","type":"string","enum":["block"],"example":"block"},"notes":{"description":"Notes","type":"string","maxLength":1000,"example":"example_notes"}},"example":{"id":12345,"account_id":1,"dt":"2025-01-17T10:30:00Z","ip":"192.168.1.1","action":"block","notes":"example_notes"}},"fraudProfile":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","nullable":false,"maxLength":255,"example":"Example Name"}},"example":{"id":12345,"account_id":1,"name":"Example Name"}},"fraudProfileInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","nullable":false,"maxLength":255,"example":"Example Name"}},"example":{"id":12345,"account_id":1,"name":"Example Name"},"required":["name"]},"setupGroup":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":100,"example":"Example Name"},"access_customer":{"description":"Access Customer","type":"integer","maxLength":4,"example":1},"access_carrier":{"description":"Access Carrier","type":"integer","maxLength":4,"example":1},"access_card":{"description":"Access Card","type":"integer","maxLength":4,"example":1},"access_carrier_card":{"description":"Access Carrier Card","type":"integer","maxLength":4,"example":1},"access_customer_card":{"description":"Access Customer Card","type":"integer","maxLength":4,"example":1},"access_cdr":{"description":"Access Cdr","type":"integer","maxLength":4,"example":1},"access_log":{"description":"Access Log","type":"integer","maxLength":4,"example":1},"access_report":{"description":"Access Report","type":"integer","maxLength":4,"example":1},"access_data":{"description":"Access Data","type":"integer","maxLength":4,"example":1},"access_pcap":{"description":"Access Pcap","type":"integer","maxLength":4,"example":1},"access_default":{"description":"Access Default","type":"array","items":{"type":"string","enum":["get","put","post","delete"]},"nullable":false,"default":"get,put,post,delete","example":"get"}},"example":{"id":12345,"account_id":1,"name":"Example Name","access_customer":1,"access_carrier":1,"access_card":1,"access_carrier_card":1,"access_customer_card":1,"access_cdr":1,"access_log":1,"access_report":1,"access_data":1,"access_pcap":1,"access_default":"get"}},"setupGroupInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":100,"example":"Example Name"},"access_customer":{"description":"Access Customer","type":"integer","maxLength":4,"example":1},"access_carrier":{"description":"Access Carrier","type":"integer","maxLength":4,"example":1},"access_card":{"description":"Access Card","type":"integer","maxLength":4,"example":1},"access_carrier_card":{"description":"Access Carrier Card","type":"integer","maxLength":4,"example":1},"access_customer_card":{"description":"Access Customer Card","type":"integer","maxLength":4,"example":1},"access_cdr":{"description":"Access Cdr","type":"integer","maxLength":4,"example":1},"access_log":{"description":"Access Log","type":"integer","maxLength":4,"example":1},"access_report":{"description":"Access Report","type":"integer","maxLength":4,"example":1},"access_data":{"description":"Access Data","type":"integer","maxLength":4,"example":1},"access_pcap":{"description":"Access Pcap","type":"integer","maxLength":4,"example":1},"access_default":{"description":"Access Default","type":"array","items":{"type":"string","enum":["get","put","post","delete"]},"nullable":false,"default":"get,put,post,delete","example":"get"}},"example":{"id":12345,"account_id":1,"name":"Example Name","access_customer":1,"access_carrier":1,"access_card":1,"access_carrier_card":1,"access_customer_card":1,"access_cdr":1,"access_log":1,"access_report":1,"access_data":1,"access_pcap":1,"access_default":"get"},"required":["name","access_default"]},"jwtRefreshTokens":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":20,"minimum":0,"example":12345},"user_id":{"description":"User Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":1},"account_id":{"description":"Account Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":1},"content":{"description":"Content","type":"string","example":"Sample content text content"},"token_hash":{"description":"Token Hash","type":"string","nullable":false,"maxLength":64,"example":"example_token_hash"},"jti":{"description":"Jti","type":"string","maxLength":255,"example":"example_jti"},"audience":{"description":"Audience","type":"string","maxLength":255,"example":"example_audience"},"expires_at":{"description":"Expires At","type":"string","format":"date-time","nullable":false,"example":"2025-01-17T10:30:00Z"},"created_at":{"description":"Created At","type":"string","format":"date-time","nullable":true,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"revoked_at":{"description":"Revoked At","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"device_info":{"description":"Device Info","type":"string","example":"Sample device_info text content"},"last_used_at":{"description":"Last Used At","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"type":{"description":"Type","type":"string","enum":["refresh","access"],"default":"refresh","example":"refresh"}},"example":{"id":12345,"user_id":1,"account_id":1,"content":"Sample content text content","token_hash":"example_token_hash","jti":"example_jti","audience":"example_audience","expires_at":"2025-01-17T10:30:00Z","created_at":"2025-01-17T10:30:00Z","revoked_at":"2025-01-17T10:30:00Z","device_info":"Sample device_info text content","last_used_at":"2025-01-17T10:30:00Z","type":"refresh"}},"setupKeys":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"example":12345},"user_id":{"description":"User Id (references user.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"user","referencesColumn":"id"},"example":1},"name":{"description":"Name","type":"string","nullable":false,"maxLength":255,"example":"Example Name"},"public_key":{"description":"Public Key","type":"string","nullable":false,"maxLength":500,"example":"example_public_key"}},"example":{"id":12345,"user_id":1,"name":"Example Name","public_key":"example_public_key"}},"setupKeysInput":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"example":12345},"user_id":{"description":"User Id (references user.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"user","referencesColumn":"id"},"example":1},"name":{"description":"Name","type":"string","nullable":false,"maxLength":255,"example":"Example Name"},"public_key":{"description":"Public Key","type":"string","nullable":false,"maxLength":500,"example":"example_public_key"}},"example":{"id":12345,"user_id":1,"name":"Example Name","public_key":"example_public_key"},"required":["user_id","name","public_key"]},"setupLanguage":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"key":{"description":"Key","type":"string","nullable":false,"maxLength":200,"example":"example_key"},"lang":{"description":"Lang","type":"string","nullable":false,"maxLength":5,"example":"example_lang"},"account_id":{"description":"Account Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":1},"translation":{"description":"Translation","type":"string","maxLength":1000,"example":"example_translation"},"none":{"description":"None","type":"string","maxLength":255,"example":"example_none"},"single":{"description":"Single","type":"string","maxLength":255,"example":"example_single"},"plural":{"description":"Plural","type":"string","maxLength":255,"example":"example_plural"}},"example":{"id":12345,"key":"example_key","lang":"example_lang","account_id":1,"translation":"example_translation","none":"example_none","single":"example_single","plural":"example_plural"}},"setupLanguageInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"key":{"description":"Key","type":"string","nullable":false,"maxLength":200,"example":"example_key"},"lang":{"description":"Lang","type":"string","nullable":false,"maxLength":5,"example":"example_lang"},"account_id":{"description":"Account Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":1},"translation":{"description":"Translation","type":"string","maxLength":1000,"example":"example_translation"},"none":{"description":"None","type":"string","maxLength":255,"example":"example_none"},"single":{"description":"Single","type":"string","maxLength":255,"example":"example_single"},"plural":{"description":"Plural","type":"string","maxLength":255,"example":"example_plural"}},"example":{"id":12345,"key":"example_key","lang":"example_lang","account_id":1,"translation":"example_translation","none":"example_none","single":"example_single","plural":"example_plural"},"required":["key","lang"]},"setupPackage":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"company_id":{"description":"Company Id","type":"integer","maxLength":11,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"description":{"description":"Description","type":"string","example":"A detailed description of the resource"},"area":{"description":"Area","type":"string","maxLength":255,"example":"example_area"},"qty":{"description":"Qty","type":"number","maxLength":8,"example":99.99},"retail":{"description":"Retail","type":"number","maxLength":14,"example":99.99},"cost":{"description":"Cost","type":"number","maxLength":14,"example":99.99},"frequency":{"description":"Frequency","type":"string","enum":["day","week","month","pro_rata"],"example":"day"},"frequency_match":{"description":"Frequency Match","type":"string","maxLength":50,"example":"example_frequency_match"},"destination":{"description":"Destination","type":"string","maxLength":255,"example":"example_destination"},"visibility":{"description":"Visibility","type":"string","enum":["Private","Public"],"default":"Public","example":"Private"},"min_spend":{"description":"Min Spend","type":"integer","maxLength":3,"minimum":0,"default":"0","example":1},"min_days":{"description":"Min Days","type":"integer","maxLength":10,"minimum":0,"example":123},"setup_cost":{"description":"Setup Cost","type":"number","maxLength":14,"example":99.99},"setup_retail":{"description":"Setup Retail","type":"number","maxLength":14,"example":99.99},"type":{"description":"Type","type":"array","items":{"type":"string","enum":["free-minutes","free-credit","spend-limit","min-spend","auto-renew","setup_first_term_charge","free-minutes-user"]},"nullable":false,"default":"","example":"free-minutes"},"cx_package_id":{"description":"Cx Package Id","type":"integer","maxLength":10,"minimum":0,"example":1}},"example":{"id":12345,"account_id":1,"company_id":1,"name":"Example Name","description":"A detailed description of the resource","area":"example_area","qty":99.99,"retail":99.99,"cost":99.99,"frequency":"day","frequency_match":"example_frequency_match","destination":"example_destination","visibility":"Private","min_spend":1,"min_days":123,"setup_cost":99.99,"setup_retail":99.99,"type":"free-minutes","cx_package_id":1}},"setupPackageInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"company_id":{"description":"Company Id","type":"integer","maxLength":11,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"description":{"description":"Description","type":"string","example":"A detailed description of the resource"},"area":{"description":"Area","type":"string","maxLength":255,"example":"example_area"},"qty":{"description":"Qty","type":"number","maxLength":8,"example":99.99},"retail":{"description":"Retail","type":"number","maxLength":14,"example":99.99},"cost":{"description":"Cost","type":"number","maxLength":14,"example":99.99},"frequency":{"description":"Frequency","type":"string","enum":["day","week","month","pro_rata"],"example":"day"},"frequency_match":{"description":"Frequency Match","type":"string","maxLength":50,"example":"example_frequency_match"},"destination":{"description":"Destination","type":"string","maxLength":255,"example":"example_destination"},"visibility":{"description":"Visibility","type":"string","enum":["Private","Public"],"default":"Public","example":"Private"},"min_spend":{"description":"Min Spend","type":"integer","maxLength":3,"minimum":0,"default":"0","example":1},"min_days":{"description":"Min Days","type":"integer","maxLength":10,"minimum":0,"example":123},"setup_cost":{"description":"Setup Cost","type":"number","maxLength":14,"example":99.99},"setup_retail":{"description":"Setup Retail","type":"number","maxLength":14,"example":99.99},"type":{"description":"Type","type":"array","items":{"type":"string","enum":["free-minutes","free-credit","spend-limit","min-spend","auto-renew","setup_first_term_charge","free-minutes-user"]},"nullable":false,"default":"","example":"free-minutes"},"cx_package_id":{"description":"Cx Package Id","type":"integer","maxLength":10,"minimum":0,"example":1}},"example":{"id":12345,"account_id":1,"company_id":1,"name":"Example Name","description":"A detailed description of the resource","area":"example_area","qty":99.99,"retail":99.99,"cost":99.99,"frequency":"day","frequency_match":"example_frequency_match","destination":"example_destination","visibility":"Private","min_spend":1,"min_days":123,"setup_cost":99.99,"setup_retail":99.99,"type":"free-minutes","cx_package_id":1},"required":["name","type"]},"setupPage":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"app_id":{"description":"App Id","type":"string","maxLength":40,"example":1},"name":{"description":"Name","type":"string","nullable":false,"maxLength":255,"example":"Example Name"},"title":{"description":"Title","type":"string","maxLength":500,"example":"Example Name"},"data":{"description":"Data","type":"object","additionalProperties":true,"example":"Sample data text content"}},"example":{"id":12345,"account_id":1,"app_id":1,"name":"Example Name","title":"Example Name","data":"Sample data text content"}},"setupPageInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"app_id":{"description":"App Id","type":"string","maxLength":40,"example":1},"name":{"description":"Name","type":"string","nullable":false,"maxLength":255,"example":"Example Name"},"title":{"description":"Title","type":"string","maxLength":500,"example":"Example Name"},"data":{"description":"Data","type":"object","additionalProperties":true,"example":"Sample data text content"}},"example":{"id":12345,"account_id":1,"app_id":1,"name":"Example Name","title":"Example Name","data":"Sample data text content"},"required":["name"]},"setupPasskey":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":255,"example":12345},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"created_at":{"description":"Created At","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"last_used":{"description":"Last Used","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"device_type":{"description":"Device Type","type":"string","maxLength":255,"example":"example_device_type"}},"example":{"id":12345,"name":"Example Name","created_at":"2025-01-17T10:30:00Z","last_used":"2025-01-17T10:30:00Z","device_type":"example_device_type"}},"setupPayment":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","nullable":false,"maxLength":11,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"payment_time":{"description":"Payment Time","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"desc":{"description":"Desc","type":"string","nullable":false,"maxLength":255,"example":"example_desc"},"amount":{"description":"Amount","type":"number","nullable":false,"maxLength":8,"example":99.99},"payment_id":{"description":"Payment Id","type":"string","maxLength":100,"example":1},"charge_id":{"description":"Charge Id","type":"string","maxLength":100,"example":1},"xero_invoice_id":{"description":"Xero Invoice Id","type":"string","maxLength":100,"example":1},"gbp_amount":{"description":"Gbp Amount","type":"number","maxLength":8,"example":99.99}},"example":{"id":12345,"account_id":1,"payment_time":"2025-01-17T10:30:00Z","desc":"example_desc","amount":99.99,"payment_id":1,"charge_id":1,"xero_invoice_id":1,"gbp_amount":99.99}},"setupPaymentInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","nullable":false,"maxLength":11,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"payment_time":{"description":"Payment Time","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"desc":{"description":"Desc","type":"string","nullable":false,"maxLength":255,"example":"example_desc"},"amount":{"description":"Amount","type":"number","nullable":false,"maxLength":8,"example":99.99},"payment_id":{"description":"Payment Id","type":"string","maxLength":100,"example":1},"charge_id":{"description":"Charge Id","type":"string","maxLength":100,"example":1},"xero_invoice_id":{"description":"Xero Invoice Id","type":"string","maxLength":100,"example":1},"gbp_amount":{"description":"Gbp Amount","type":"number","maxLength":8,"example":99.99}},"example":{"id":12345,"account_id":1,"payment_time":"2025-01-17T10:30:00Z","desc":"example_desc","amount":99.99,"payment_id":1,"charge_id":1,"xero_invoice_id":1,"gbp_amount":99.99},"required":["payment_time","desc","amount"]},"setupPrefixSet":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"company_id":{"description":"Company Id","type":"integer","maxLength":11,"example":1},"name":{"description":"Name","type":"string","nullable":false,"maxLength":255,"example":"Example Name"},"data":{"description":"Data","type":"string","example":"Sample data text content"},"query":{"description":"Query","type":"string","example":"Sample query text content"},"flags":{"description":"Flags","type":"array","items":{"type":"string","enum":["GLOBAL_DN","GLOBAL_CLI","GLOBAL_CLI_ALLOW","DATABASE","COMPANY_READ","COMPANY_WRITE"]},"default":"","example":"GLOBAL_DN"}},"example":{"id":12345,"account_id":1,"company_id":1,"name":"Example Name","data":"Sample data text content","query":"Sample query text content","flags":"GLOBAL_DN"}},"setupPrefixSetInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"company_id":{"description":"Company Id","type":"integer","maxLength":11,"example":1},"name":{"description":"Name","type":"string","nullable":false,"maxLength":255,"example":"Example Name"},"data":{"description":"Data","type":"string","example":"Sample data text content"},"query":{"description":"Query","type":"string","example":"Sample query text content"},"flags":{"description":"Flags","type":"array","items":{"type":"string","enum":["GLOBAL_DN","GLOBAL_CLI","GLOBAL_CLI_ALLOW","DATABASE","COMPANY_READ","COMPANY_WRITE"]},"default":"","example":"GLOBAL_DN"}},"example":{"id":12345,"account_id":1,"company_id":1,"name":"Example Name","data":"Sample data text content","query":"Sample query text content","flags":"GLOBAL_DN"},"required":["name"]},"setupQuery":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":40,"default":"uuid()","example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"app_id":{"description":"App Id","type":"string","maxLength":40,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"query":{"description":"Query","type":"string","example":"Sample query text content"},"src":{"description":"Src","type":"string","maxLength":100,"example":"example_src"},"vars":{"description":"Vars","type":"object","additionalProperties":true,"maxLength":1000,"example":"example_vars"}},"example":{"id":12345,"account_id":1,"app_id":1,"name":"Example Name","query":"Sample query text content","src":"example_src","vars":"example_vars"}},"setupQueryInput":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":40,"default":"uuid()","example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"app_id":{"description":"App Id","type":"string","maxLength":40,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"query":{"description":"Query","type":"string","example":"Sample query text content"},"src":{"description":"Src","type":"string","maxLength":100,"example":"example_src"},"vars":{"description":"Vars","type":"object","additionalProperties":true,"maxLength":1000,"example":"example_vars"}},"example":{"id":12345,"account_id":1,"app_id":1,"name":"Example Name","query":"Sample query text content","src":"example_src","vars":"example_vars"},"required":["name"]},"setupRepo":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":40,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"project_id":{"description":"Project Id (references project.id)","type":"string","maxLength":40,"x-foreignKey":{"referencesTable":"project","referencesColumn":"id"},"example":1},"version":{"description":"Version","type":"string","maxLength":50,"example":"example_version"},"approved":{"description":"Approved","type":"integer","maxLength":3,"minimum":0,"default":"0","example":1},"published_date":{"description":"Published Date","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"commit_message":{"description":"Commit Message","type":"string","maxLength":2000,"example":"example_commit_message"}},"example":{"id":12345,"account_id":1,"project_id":1,"version":"example_version","approved":1,"published_date":"2025-01-17T10:30:00Z","commit_message":"example_commit_message"}},"setupRepoInput":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":40,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"project_id":{"description":"Project Id (references project.id)","type":"string","maxLength":40,"x-foreignKey":{"referencesTable":"project","referencesColumn":"id"},"example":1},"version":{"description":"Version","type":"string","maxLength":50,"example":"example_version"},"approved":{"description":"Approved","type":"integer","maxLength":3,"minimum":0,"default":"0","example":1},"published_date":{"description":"Published Date","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"commit_message":{"description":"Commit Message","type":"string","maxLength":2000,"example":"example_commit_message"}},"example":{"id":12345,"account_id":1,"project_id":1,"version":"example_version","approved":1,"published_date":"2025-01-17T10:30:00Z","commit_message":"example_commit_message"}},"setupReseller":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":11,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"email":{"description":"Email","type":"string","format":"email","maxLength":255,"example":"user@example.com"},"credit":{"description":"Credit","type":"number","nullable":false,"maxLength":10,"default":"0","example":99.99}},"example":{"id":12345,"account_id":1,"name":"Example Name","email":"user@example.com","credit":99.99}},"setupResellerInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":11,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"email":{"description":"Email","type":"string","format":"email","maxLength":255,"example":"user@example.com"},"credit":{"description":"Credit","type":"number","nullable":false,"maxLength":10,"default":"0","example":99.99}},"example":{"id":12345,"account_id":1,"name":"Example Name","email":"user@example.com","credit":99.99},"required":["name","credit"]},"setupRtpBlock":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"ip":{"description":"Ip","type":"string","format":"ipv4","maxLength":255,"example":"192.168.1.1"},"cidr":{"description":"Cidr","type":"string","maxLength":255,"example":"example_cidr"},"from_ip":{"description":"From Ip","type":"integer","format":"ipv4","maxLength":255,"minimum":0,"example":123},"to_ip":{"description":"To Ip","type":"integer","format":"ipv4","maxLength":255,"minimum":0,"example":123},"flags":{"description":"Flags","type":"array","items":{"type":"string","enum":["CUSTOMER_IN","CUSTOMER_OUT","PROVIDER_IN","PROVIDER_OUT"]},"default":"","example":"CUSTOMER_IN"},"notes":{"description":"Notes","type":"string","maxLength":1000,"example":"example_notes"}},"example":{"id":12345,"account_id":1,"ip":"192.168.1.1","cidr":"example_cidr","from_ip":123,"to_ip":123,"flags":"CUSTOMER_IN","notes":"example_notes"}},"setupRtpBlockInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"ip":{"description":"Ip","type":"string","format":"ipv4","maxLength":255,"example":"192.168.1.1"},"cidr":{"description":"Cidr","type":"string","maxLength":255,"example":"example_cidr"},"from_ip":{"description":"From Ip","type":"integer","format":"ipv4","maxLength":255,"minimum":0,"example":123},"to_ip":{"description":"To Ip","type":"integer","format":"ipv4","maxLength":255,"minimum":0,"example":123},"flags":{"description":"Flags","type":"array","items":{"type":"string","enum":["CUSTOMER_IN","CUSTOMER_OUT","PROVIDER_IN","PROVIDER_OUT"]},"default":"","example":"CUSTOMER_IN"},"notes":{"description":"Notes","type":"string","maxLength":1000,"example":"example_notes"}},"example":{"id":12345,"account_id":1,"ip":"192.168.1.1","cidr":"example_cidr","from_ip":123,"to_ip":123,"flags":"CUSTOMER_IN","notes":"example_notes"}},"setupRtpZone":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"rtp_group_id":{"description":"Rtp Group Id (references rtp_group.id)","type":"integer","nullable":false,"maxLength":11,"minimum":0,"x-foreignKey":{"referencesTable":"rtp_group","referencesColumn":"id"},"example":1}},"example":{"id":12345,"account_id":1,"rtp_group_id":1}},"setupRtpZoneInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"rtp_group_id":{"description":"Rtp Group Id (references rtp_group.id)","type":"integer","nullable":false,"maxLength":11,"minimum":0,"x-foreignKey":{"referencesTable":"rtp_group","referencesColumn":"id"},"example":1}},"example":{"id":12345,"account_id":1,"rtp_group_id":1},"required":["rtp_group_id"]},"setupRtp":{"type":"object","properties":{"ip":{"description":"Ip (unique)","type":"string","format":"ipv4","maxLength":255,"x-unique":true,"example":"192.168.1.1"},"ipv6":{"description":"Ipv 6","type":"string","maxLength":255,"example":"example_ipv6"},"alias":{"description":"Alias","type":"string","maxLength":50,"example":"example_alias"}},"example":{"ip":"192.168.1.1","ipv6":"example_ipv6","alias":"example_alias"}},"setupServer":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"type":{"description":"Type","type":"string","enum":["Database","Switch","Cache","Dispatcher","RTP","PBX","SIPTest","Javascript","Web","Other","3CX","Any-Dispatcher","Registrar","Turn","AnyEdge-Dev","AnyRTP-Control","AnyRTP-Actuator","Box"],"default":"Switch","example":"Database"},"ip":{"description":"Ip (unique)","type":"string","format":"ipv4","maxLength":255,"x-unique":true,"example":"192.168.1.1"},"ipv6":{"description":"Ipv 6","type":"string","maxLength":255,"example":"example_ipv6"},"alias":{"description":"Alias","type":"string","maxLength":50,"example":"example_alias"},"status":{"description":"Status","type":"string","enum":["Active","Failed","Paused","Unallocated","Expired","Installing","Upgrading"],"nullable":false,"default":"Active","example":"Active"},"managed":{"description":"Managed","type":"integer","maxLength":4,"example":1},"ssh_user":{"description":"Ssh User","type":"string","maxLength":50,"example":"example_ssh_user"},"ssh_password":{"description":"Ssh Password","type":"string","format":"password","maxLength":50,"example":"example_ssh_password"},"port":{"description":"Port","type":"integer","maxLength":10,"minimum":0,"example":123},"interconnect_form":{"description":"Interconnect Form","type":"array","items":{"type":"string","enum":["termination-ingress","termination-egress","origination-ingress","origination-egress"]},"default":"","example":"termination-ingress"},"rtp_groups":{"description":"Rtp Groups","type":"string","maxLength":50,"example":"example_rtp_groups"},"channels":{"description":"Channels","type":"integer","maxLength":10,"minimum":0,"default":"100","example":123},"cps":{"description":"Cps","type":"integer","maxLength":10,"minimum":0,"default":"10","example":123},"rtp_capacity":{"description":"Rtp Capacity","type":"integer","maxLength":10,"minimum":0,"default":"100","example":123},"last_activity":{"description":"Last Activity","type":"integer","nullable":true,"maxLength":20,"minimum":0,"example":1000000},"platform":{"description":"Platform","type":"string","maxLength":10,"example":"example_platform"},"expire_date":{"description":"Expire Date","type":"string","format":"date","example":"2025-01-17T10:30:00Z"},"cost":{"description":"Cost","type":"number","nullable":false,"maxLength":8,"default":"0","example":99.99},"setting":{"description":"Setting","type":"string","format":"binary","example":"base64-encoded-data"},"setting_json":{"description":"Setting Json","type":"string","example":"Sample setting_json text content"},"capacity_302":{"description":"Capacity 302","type":"string","maxLength":255,"example":"example_capacity_302"},"cpu_count":{"description":"Cpu Count","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"1","example":10},"ram":{"description":"Ram","type":"integer","maxLength":10,"minimum":0,"example":123},"s_mem":{"description":"S Mem","type":"integer","maxLength":10,"minimum":0,"default":"32","example":123},"p_mem":{"description":"P Mem","type":"integer","maxLength":10,"minimum":0,"default":"4","example":123},"processes":{"description":"Processes","type":"integer","maxLength":10,"minimum":0,"default":"8","example":123},"last_call":{"description":"Last Call","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"location":{"description":"Location","type":"string","maxLength":255,"example":"example_location"},"provider_id":{"description":"Provider Id","type":"string","maxLength":50,"example":1},"rack_info":{"description":"Rack Info","type":"string","maxLength":255,"example":"example_rack_info"},"detailed_spec":{"description":"Detailed Spec","type":"string","maxLength":1000,"example":"example_detailed_spec"},"disk_size":{"description":"Disk Size","type":"string","maxLength":10,"example":"example_disk_size"},"fqdn":{"description":"Fqdn","type":"string","maxLength":255,"example":"example_fqdn"},"stale":{"description":"Stale","type":"integer","maxLength":3,"minimum":0,"default":"0","example":1},"startup_time":{"description":"Startup Time","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"approved_delete":{"description":"Approved Delete","type":"string","maxLength":255,"example":"example_approved_delete"},"internal_ip":{"description":"Internal Ip","type":"string","format":"ipv4","maxLength":15,"example":"example_internal_ip"},"tinc_private_key":{"description":"Tinc Private Key","type":"string","maxLength":5000,"example":"example_tinc_private_key"},"tinc_public_key":{"description":"Tinc Public Key","type":"string","maxLength":5000,"example":"example_tinc_public_key"},"upgrade_scheduled":{"description":"Upgrade Scheduled","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"cluster_id":{"description":"Cluster Id","type":"integer","maxLength":10,"minimum":0,"example":1},"image_slug":{"description":"Image Slug","type":"string","maxLength":20,"example":"example_image_slug"},"size_slug":{"description":"Size Slug","type":"string","maxLength":20,"example":"example_size_slug"},"last_provision":{"description":"Last Provision","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"created_date":{"description":"Created Date","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"flags":{"description":"Flags","type":"string","maxLength":255,"default":"AUTO_UPGRADE,DISABLE_UAC_PING","example":"example_flags"},"routing_zone":{"description":"Routing Zone","type":"string","maxLength":255,"default":"eu","example":"example_routing_zone"},"tasks":{"description":"Tasks","type":"string","maxLength":255,"example":"example_tasks"},"registrar":{"description":"Registrar","type":"string","maxLength":255,"example":"example_registrar"},"ansible_toml":{"description":"Ansible Toml","type":"string","example":"Sample ansible_toml text content"},"last_deploy":{"description":"Last Deploy","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"certs":{"description":"Certs","type":"string","maxLength":255,"example":"example_certs"},"provider_cost_usd":{"description":"Provider Cost Usd","type":"number","maxLength":10,"minimum":0,"example":99.99},"min_cost":{"description":"Min Cost","type":"number","maxLength":10,"default":"20","example":99.99},"peak_min_cost":{"description":"Peak Min Cost","type":"number","maxLength":10,"default":"20","example":99.99},"cpu_benchmark":{"description":"Cpu Benchmark","type":"integer","maxLength":20,"minimum":0,"example":1000000},"box_id":{"description":"Box Id","type":"integer","maxLength":10,"minimum":0,"example":1},"last_resize":{"description":"Last Resize","type":"string","format":"date","nullable":true,"default":"current_timestamp()","example":"2025-01-17"},"max_30_day_channels":{"description":"Max 30 Day Channels","type":"integer","maxLength":10,"minimum":0,"example":123},"policy_cohort_id":{"description":"Policy Cohort Id","type":"integer","maxLength":10,"minimum":0,"example":1}},"example":{"id":12345,"account_id":1,"type":"Database","ip":"192.168.1.1","ipv6":"example_ipv6","alias":"example_alias","status":"Active","managed":1,"ssh_user":"example_ssh_user","ssh_password":"example_ssh_password","port":123,"interconnect_form":"termination-ingress","rtp_groups":"example_rtp_groups","channels":123,"cps":123,"rtp_capacity":123,"last_activity":1000000,"platform":"example_platform","expire_date":"2025-01-17T10:30:00Z","cost":99.99,"setting":"base64-encoded-data","setting_json":"Sample setting_json text content","capacity_302":"example_capacity_302","cpu_count":10,"ram":123,"s_mem":123,"p_mem":123,"processes":123,"last_call":"2025-01-17T10:30:00Z","location":"example_location","provider_id":1,"rack_info":"example_rack_info","detailed_spec":"example_detailed_spec","disk_size":"example_disk_size","fqdn":"example_fqdn","stale":1,"startup_time":"2025-01-17T10:30:00Z","approved_delete":"example_approved_delete","internal_ip":"example_internal_ip","tinc_private_key":"example_tinc_private_key","tinc_public_key":"example_tinc_public_key","upgrade_scheduled":"2025-01-17T10:30:00Z","cluster_id":1,"image_slug":"example_image_slug","size_slug":"example_size_slug","last_provision":"2025-01-17T10:30:00Z","created_date":"2025-01-17T10:30:00Z","flags":"example_flags","routing_zone":"example_routing_zone","tasks":"example_tasks","registrar":"example_registrar","ansible_toml":"Sample ansible_toml text content","last_deploy":"2025-01-17T10:30:00Z","certs":"example_certs","provider_cost_usd":99.99,"min_cost":99.99,"peak_min_cost":99.99,"cpu_benchmark":1000000,"box_id":1,"last_resize":"2025-01-17","max_30_day_channels":123,"policy_cohort_id":1}},"setupServerInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"type":{"description":"Type","type":"string","enum":["Database","Switch","Cache","Dispatcher","RTP","PBX","SIPTest","Javascript","Web","Other","3CX","Any-Dispatcher","Registrar","Turn","AnyEdge-Dev","AnyRTP-Control","AnyRTP-Actuator","Box"],"default":"Switch","example":"Database"},"ip":{"description":"Ip (unique)","type":"string","format":"ipv4","maxLength":255,"x-unique":true,"example":"192.168.1.1"},"ipv6":{"description":"Ipv 6","type":"string","maxLength":255,"example":"example_ipv6"},"alias":{"description":"Alias","type":"string","maxLength":50,"example":"example_alias"},"status":{"description":"Status","type":"string","enum":["Active","Failed","Paused","Unallocated","Expired","Installing","Upgrading"],"nullable":false,"default":"Active","example":"Active"},"managed":{"description":"Managed","type":"integer","maxLength":4,"example":1},"ssh_user":{"description":"Ssh User","type":"string","maxLength":50,"example":"example_ssh_user"},"ssh_password":{"description":"Ssh Password","type":"string","format":"password","maxLength":50,"example":"example_ssh_password"},"port":{"description":"Port","type":"integer","maxLength":10,"minimum":0,"example":123},"interconnect_form":{"description":"Interconnect Form","type":"array","items":{"type":"string","enum":["termination-ingress","termination-egress","origination-ingress","origination-egress"]},"default":"","example":"termination-ingress"},"rtp_groups":{"description":"Rtp Groups","type":"string","maxLength":50,"example":"example_rtp_groups"},"channels":{"description":"Channels","type":"integer","maxLength":10,"minimum":0,"default":"100","example":123},"cps":{"description":"Cps","type":"integer","maxLength":10,"minimum":0,"default":"10","example":123},"rtp_capacity":{"description":"Rtp Capacity","type":"integer","maxLength":10,"minimum":0,"default":"100","example":123},"last_activity":{"description":"Last Activity","type":"integer","nullable":true,"maxLength":20,"minimum":0,"example":1000000},"platform":{"description":"Platform","type":"string","maxLength":10,"example":"example_platform"},"expire_date":{"description":"Expire Date","type":"string","format":"date","example":"2025-01-17T10:30:00Z"},"cost":{"description":"Cost","type":"number","nullable":false,"maxLength":8,"default":"0","example":99.99},"setting":{"description":"Setting","type":"string","format":"binary","example":"base64-encoded-data"},"setting_json":{"description":"Setting Json","type":"string","example":"Sample setting_json text content"},"capacity_302":{"description":"Capacity 302","type":"string","maxLength":255,"example":"example_capacity_302"},"cpu_count":{"description":"Cpu Count","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"1","example":10},"ram":{"description":"Ram","type":"integer","maxLength":10,"minimum":0,"example":123},"s_mem":{"description":"S Mem","type":"integer","maxLength":10,"minimum":0,"default":"32","example":123},"p_mem":{"description":"P Mem","type":"integer","maxLength":10,"minimum":0,"default":"4","example":123},"processes":{"description":"Processes","type":"integer","maxLength":10,"minimum":0,"default":"8","example":123},"last_call":{"description":"Last Call","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"location":{"description":"Location","type":"string","maxLength":255,"example":"example_location"},"provider_id":{"description":"Provider Id","type":"string","maxLength":50,"example":1},"rack_info":{"description":"Rack Info","type":"string","maxLength":255,"example":"example_rack_info"},"detailed_spec":{"description":"Detailed Spec","type":"string","maxLength":1000,"example":"example_detailed_spec"},"disk_size":{"description":"Disk Size","type":"string","maxLength":10,"example":"example_disk_size"},"fqdn":{"description":"Fqdn","type":"string","maxLength":255,"example":"example_fqdn"},"stale":{"description":"Stale","type":"integer","maxLength":3,"minimum":0,"default":"0","example":1},"startup_time":{"description":"Startup Time","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"approved_delete":{"description":"Approved Delete","type":"string","maxLength":255,"example":"example_approved_delete"},"internal_ip":{"description":"Internal Ip","type":"string","format":"ipv4","maxLength":15,"example":"example_internal_ip"},"tinc_private_key":{"description":"Tinc Private Key","type":"string","maxLength":5000,"example":"example_tinc_private_key"},"tinc_public_key":{"description":"Tinc Public Key","type":"string","maxLength":5000,"example":"example_tinc_public_key"},"upgrade_scheduled":{"description":"Upgrade Scheduled","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"cluster_id":{"description":"Cluster Id","type":"integer","maxLength":10,"minimum":0,"example":1},"image_slug":{"description":"Image Slug","type":"string","maxLength":20,"example":"example_image_slug"},"size_slug":{"description":"Size Slug","type":"string","maxLength":20,"example":"example_size_slug"},"last_provision":{"description":"Last Provision","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"created_date":{"description":"Created Date","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"flags":{"description":"Flags","type":"string","maxLength":255,"default":"AUTO_UPGRADE,DISABLE_UAC_PING","example":"example_flags"},"routing_zone":{"description":"Routing Zone","type":"string","maxLength":255,"default":"eu","example":"example_routing_zone"},"tasks":{"description":"Tasks","type":"string","maxLength":255,"example":"example_tasks"},"registrar":{"description":"Registrar","type":"string","maxLength":255,"example":"example_registrar"},"ansible_toml":{"description":"Ansible Toml","type":"string","example":"Sample ansible_toml text content"},"last_deploy":{"description":"Last Deploy","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"certs":{"description":"Certs","type":"string","maxLength":255,"example":"example_certs"},"provider_cost_usd":{"description":"Provider Cost Usd","type":"number","maxLength":10,"minimum":0,"example":99.99},"min_cost":{"description":"Min Cost","type":"number","maxLength":10,"default":"20","example":99.99},"peak_min_cost":{"description":"Peak Min Cost","type":"number","maxLength":10,"default":"20","example":99.99},"cpu_benchmark":{"description":"Cpu Benchmark","type":"integer","maxLength":20,"minimum":0,"example":1000000},"box_id":{"description":"Box Id","type":"integer","maxLength":10,"minimum":0,"example":1},"last_resize":{"description":"Last Resize","type":"string","format":"date","nullable":true,"default":"current_timestamp()","example":"2025-01-17"},"max_30_day_channels":{"description":"Max 30 Day Channels","type":"integer","maxLength":10,"minimum":0,"example":123},"policy_cohort_id":{"description":"Policy Cohort Id","type":"integer","maxLength":10,"minimum":0,"example":1}},"example":{"id":12345,"account_id":1,"type":"Database","ip":"192.168.1.1","ipv6":"example_ipv6","alias":"example_alias","status":"Active","managed":1,"ssh_user":"example_ssh_user","ssh_password":"example_ssh_password","port":123,"interconnect_form":"termination-ingress","rtp_groups":"example_rtp_groups","channels":123,"cps":123,"rtp_capacity":123,"last_activity":1000000,"platform":"example_platform","expire_date":"2025-01-17T10:30:00Z","cost":99.99,"setting":"base64-encoded-data","setting_json":"Sample setting_json text content","capacity_302":"example_capacity_302","cpu_count":10,"ram":123,"s_mem":123,"p_mem":123,"processes":123,"last_call":"2025-01-17T10:30:00Z","location":"example_location","provider_id":1,"rack_info":"example_rack_info","detailed_spec":"example_detailed_spec","disk_size":"example_disk_size","fqdn":"example_fqdn","stale":1,"startup_time":"2025-01-17T10:30:00Z","approved_delete":"example_approved_delete","internal_ip":"example_internal_ip","tinc_private_key":"example_tinc_private_key","tinc_public_key":"example_tinc_public_key","upgrade_scheduled":"2025-01-17T10:30:00Z","cluster_id":1,"image_slug":"example_image_slug","size_slug":"example_size_slug","last_provision":"2025-01-17T10:30:00Z","created_date":"2025-01-17T10:30:00Z","flags":"example_flags","routing_zone":"example_routing_zone","tasks":"example_tasks","registrar":"example_registrar","ansible_toml":"Sample ansible_toml text content","last_deploy":"2025-01-17T10:30:00Z","certs":"example_certs","provider_cost_usd":99.99,"min_cost":99.99,"peak_min_cost":99.99,"cpu_benchmark":1000000,"box_id":1,"last_resize":"2025-01-17","max_30_day_channels":123,"policy_cohort_id":1},"required":["status","cost","cpu_count"]},"setupStirShakenCertInput":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":30,"default":"left(md5(uuid()","example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"cert":{"description":"Cert","type":"string","example":"Sample cert text content"},"key":{"description":"Key","type":"string","example":"Sample key text content"},"old_id":{"description":"Old Id","type":"integer","maxLength":11,"example":1}},"example":{"id":12345,"account_id":1,"name":"Example Name","cert":"Sample cert text content","key":"Sample key text content","old_id":1},"required":["name"]},"setupStirShakenCert":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":30,"default":"left(md5(uuid()","example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"cert":{"description":"Cert","type":"string","example":"Sample cert text content"},"key":{"description":"Key","type":"string","example":"Sample key text content"},"old_id":{"description":"Old Id","type":"integer","maxLength":11,"example":1}},"example":{"id":12345,"account_id":1,"name":"Example Name","cert":"Sample cert text content","key":"Sample key text content","old_id":1}},"setupSipProfile":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"webphone_licence":{"description":"Webphone Licence","type":"integer","maxLength":255,"minimum":0,"example":123},"flags":{"description":"Flags","type":"string","nullable":false,"maxLength":255,"example":"example_flags"},"profile_capacity":{"description":"Profile Capacity","type":"integer","nullable":false,"maxLength":255,"minimum":0,"example":123},"barge_group":{"description":"Barge Group","type":"string","maxLength":255,"example":"example_barge_group"},"pbx_server":{"description":"Pbx Server","type":"string","maxLength":255,"example":"example_pbx_server"}},"example":{"id":12345,"account_id":1,"name":"Example Name","webphone_licence":123,"flags":"example_flags","profile_capacity":123,"barge_group":"example_barge_group","pbx_server":"example_pbx_server"}},"setupSipProfileInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"webphone_licence":{"description":"Webphone Licence","type":"integer","maxLength":255,"minimum":0,"example":123},"flags":{"description":"Flags","type":"string","nullable":false,"maxLength":255,"example":"example_flags"},"profile_capacity":{"description":"Profile Capacity","type":"integer","nullable":false,"maxLength":255,"minimum":0,"example":123},"barge_group":{"description":"Barge Group","type":"string","maxLength":255,"example":"example_barge_group"},"pbx_server":{"description":"Pbx Server","type":"string","maxLength":255,"example":"example_pbx_server"}},"example":{"id":12345,"account_id":1,"name":"Example Name","webphone_licence":123,"flags":"example_flags","profile_capacity":123,"barge_group":"example_barge_group","pbx_server":"example_pbx_server"},"required":["name","flags","profile_capacity"]},"setupTemplate":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":1},"company_id":{"description":"Company Id","type":"integer","maxLength":10,"minimum":0,"example":1},"app_id":{"description":"App Id","type":"string","maxLength":40,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"subject":{"description":"Subject","type":"string","maxLength":500,"example":"example_subject"},"text":{"description":"Text","type":"string","example":"Sample text text content"},"html":{"description":"Html","type":"string","example":"Sample html text content"},"sms":{"description":"Sms","type":"string","maxLength":1000,"example":"example_sms"},"script":{"description":"Script","type":"string","example":"Sample script text content"}},"example":{"id":12345,"account_id":1,"company_id":1,"app_id":1,"name":"Example Name","subject":"example_subject","text":"Sample text text content","html":"Sample html text content","sms":"example_sms","script":"Sample script text content"}},"setupTemplateInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":1},"company_id":{"description":"Company Id","type":"integer","maxLength":10,"minimum":0,"example":1},"app_id":{"description":"App Id","type":"string","maxLength":40,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"subject":{"description":"Subject","type":"string","maxLength":500,"example":"example_subject"},"text":{"description":"Text","type":"string","example":"Sample text text content"},"html":{"description":"Html","type":"string","example":"Sample html text content"},"sms":{"description":"Sms","type":"string","maxLength":1000,"example":"example_sms"},"script":{"description":"Script","type":"string","example":"Sample script text content"}},"example":{"id":12345,"account_id":1,"company_id":1,"app_id":1,"name":"Example Name","subject":"example_subject","text":"Sample text text content","html":"Sample html text content","sms":"example_sms","script":"Sample script text content"},"required":["name"]},"setupTranscriptionClassificationPolicy":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"default":"uuid()","example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"company_id":{"description":"Company Id (references company.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"company","referencesColumn":"id"},"example":1},"classifier_id":{"description":"Classifier Id (references transcription_classifier.id)","type":"string","nullable":false,"x-foreignKey":{"referencesTable":"transcription_classifier","referencesColumn":"id"},"example":1},"name":{"description":"Name","type":"string","nullable":false,"maxLength":128,"example":"Example Name"},"description":{"description":"Description","type":"string","maxLength":1000,"example":"A detailed description of the resource"},"action":{"description":"Action","type":"string","enum":["HANGUP","ALERT","TAG"],"nullable":false,"example":"HANGUP"},"tag":{"description":"Tag","type":"string","maxLength":64,"example":"example_tag"},"stage":{"description":"Stage","type":"array","items":{"type":"string","enum":["live","final"]},"nullable":false,"default":"live","example":"live"},"mode":{"description":"Mode","type":"string","enum":["shadow","active"],"nullable":false,"default":"shadow","example":"shadow"},"min_consecutive":{"description":"Min Consecutive","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"1","example":1},"min_call_seconds":{"description":"Min Call Seconds","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"0","example":100},"enabled":{"description":"Enabled","type":"integer","nullable":false,"maxLength":1,"default":"1","example":true},"created_at":{"description":"Created At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"updated_at":{"description":"Updated At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"}},"example":{"id":12345,"account_id":1,"company_id":1,"classifier_id":1,"name":"Example Name","description":"A detailed description of the resource","action":"HANGUP","tag":"example_tag","stage":"live","mode":"shadow","min_consecutive":1,"min_call_seconds":100,"enabled":true,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"}},"setupTranscriptionClassificationPolicyInput":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"default":"uuid()","example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"company_id":{"description":"Company Id (references company.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"company","referencesColumn":"id"},"example":1},"classifier_id":{"description":"Classifier Id (references transcription_classifier.id)","type":"string","nullable":false,"x-foreignKey":{"referencesTable":"transcription_classifier","referencesColumn":"id"},"example":1},"name":{"description":"Name","type":"string","nullable":false,"maxLength":128,"example":"Example Name"},"description":{"description":"Description","type":"string","maxLength":1000,"example":"A detailed description of the resource"},"action":{"description":"Action","type":"string","enum":["HANGUP","ALERT","TAG"],"nullable":false,"example":"HANGUP"},"tag":{"description":"Tag","type":"string","maxLength":64,"example":"example_tag"},"stage":{"description":"Stage","type":"array","items":{"type":"string","enum":["live","final"]},"nullable":false,"default":"live","example":"live"},"mode":{"description":"Mode","type":"string","enum":["shadow","active"],"nullable":false,"default":"shadow","example":"shadow"},"min_consecutive":{"description":"Min Consecutive","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"1","example":1},"min_call_seconds":{"description":"Min Call Seconds","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"0","example":100},"enabled":{"description":"Enabled","type":"integer","nullable":false,"maxLength":1,"default":"1","example":true},"created_at":{"description":"Created At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"updated_at":{"description":"Updated At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"}},"example":{"id":12345,"account_id":1,"company_id":1,"classifier_id":1,"name":"Example Name","description":"A detailed description of the resource","action":"HANGUP","tag":"example_tag","stage":"live","mode":"shadow","min_consecutive":1,"min_call_seconds":100,"enabled":true,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"},"required":["classifier_id","name","action","stage","mode","min_consecutive","min_call_seconds","enabled"]},"setupTranscriptionClassifierAssignment":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"default":"uuid()","example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"company_id":{"description":"Company Id (references company.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"company","referencesColumn":"id"},"example":1},"classifier_id":{"description":"Classifier Id (references transcription_classifier.id)","type":"string","nullable":false,"x-foreignKey":{"referencesTable":"transcription_classifier","referencesColumn":"id"},"example":1},"mode":{"description":"Mode","type":"string","enum":["shadow","active"],"nullable":false,"default":"shadow","example":"shadow"},"enabled":{"description":"Enabled","type":"integer","nullable":false,"maxLength":1,"default":"1","example":true},"created_at":{"description":"Created At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"updated_at":{"description":"Updated At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"company_scope":{"description":"Company Scope","type":"integer","maxLength":10,"minimum":0,"example":123}},"example":{"id":12345,"account_id":1,"company_id":1,"classifier_id":1,"mode":"shadow","enabled":true,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z","company_scope":123}},"setupTranscriptionClassifierAssignmentInput":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"default":"uuid()","example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"company_id":{"description":"Company Id (references company.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"company","referencesColumn":"id"},"example":1},"classifier_id":{"description":"Classifier Id (references transcription_classifier.id)","type":"string","nullable":false,"x-foreignKey":{"referencesTable":"transcription_classifier","referencesColumn":"id"},"example":1},"mode":{"description":"Mode","type":"string","enum":["shadow","active"],"nullable":false,"default":"shadow","example":"shadow"},"enabled":{"description":"Enabled","type":"integer","nullable":false,"maxLength":1,"default":"1","example":true},"created_at":{"description":"Created At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"updated_at":{"description":"Updated At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"company_scope":{"description":"Company Scope","type":"integer","maxLength":10,"minimum":0,"example":123}},"example":{"id":12345,"account_id":1,"company_id":1,"classifier_id":1,"mode":"shadow","enabled":true,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z","company_scope":123},"required":["classifier_id","mode","enabled"]},"setupTranscriptionClassifier":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"default":"uuid()","example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"name":{"description":"Name","type":"string","nullable":false,"maxLength":128,"example":"Example Name"},"description":{"description":"Description","type":"string","maxLength":1000,"example":"A detailed description of the resource"},"context":{"description":"Context","type":"string","maxLength":2000,"example":"example_context"},"model":{"description":"Model","type":"string","nullable":false,"maxLength":128,"default":"typesafe/jev-1.13","example":"example_model"},"live_enabled":{"description":"Live Enabled","type":"integer","nullable":false,"maxLength":1,"default":"1","example":true},"final_enabled":{"description":"Final Enabled","type":"integer","nullable":false,"maxLength":1,"default":"1","example":true},"min_first_words":{"description":"Min First Words","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"8","example":100},"min_new_words":{"description":"Min New Words","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"15","example":100},"min_interval_s":{"description":"Min Interval S","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"5","example":100},"final_idle_s":{"description":"Final Idle S","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"90","example":100},"fts_trigger":{"description":"Fts Trigger","type":"integer","nullable":false,"maxLength":1,"default":"1","example":1},"revision":{"description":"Revision","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"1","example":123},"created_at":{"description":"Created At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"updated_at":{"description":"Updated At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"}},"example":{"id":12345,"account_id":1,"name":"Example Name","description":"A detailed description of the resource","context":"example_context","model":"example_model","live_enabled":true,"final_enabled":true,"min_first_words":100,"min_new_words":100,"min_interval_s":100,"final_idle_s":100,"fts_trigger":1,"revision":123,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"}},"setupTranscriptionClassifierInput":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"default":"uuid()","example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"name":{"description":"Name","type":"string","nullable":false,"maxLength":128,"example":"Example Name"},"description":{"description":"Description","type":"string","maxLength":1000,"example":"A detailed description of the resource"},"context":{"description":"Context","type":"string","maxLength":2000,"example":"example_context"},"model":{"description":"Model","type":"string","nullable":false,"maxLength":128,"default":"typesafe/jev-1.13","example":"example_model"},"live_enabled":{"description":"Live Enabled","type":"integer","nullable":false,"maxLength":1,"default":"1","example":true},"final_enabled":{"description":"Final Enabled","type":"integer","nullable":false,"maxLength":1,"default":"1","example":true},"min_first_words":{"description":"Min First Words","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"8","example":100},"min_new_words":{"description":"Min New Words","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"15","example":100},"min_interval_s":{"description":"Min Interval S","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"5","example":100},"final_idle_s":{"description":"Final Idle S","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"90","example":100},"fts_trigger":{"description":"Fts Trigger","type":"integer","nullable":false,"maxLength":1,"default":"1","example":1},"revision":{"description":"Revision","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"1","example":123},"created_at":{"description":"Created At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"updated_at":{"description":"Updated At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"}},"example":{"id":12345,"account_id":1,"name":"Example Name","description":"A detailed description of the resource","context":"example_context","model":"example_model","live_enabled":true,"final_enabled":true,"min_first_words":100,"min_new_words":100,"min_interval_s":100,"final_idle_s":100,"fts_trigger":1,"revision":123,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"},"required":["name","model","live_enabled","final_enabled","min_first_words","min_new_words","min_interval_s","final_idle_s","fts_trigger","revision"]},"setupUser":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":11,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"reseller_id":{"description":"Reseller Id","type":"integer","maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":50,"example":"Example Name"},"email":{"description":"Email (unique)","type":"string","format":"email","maxLength":255,"x-unique":true,"example":"user@example.com"},"password":{"description":"Password","type":"string","format":"password","maxLength":255,"example":"********"},"mobile":{"description":"Mobile","type":"string","maxLength":15,"example":"+1-555-123-4567"},"skype":{"description":"Skype","type":"string","maxLength":50,"example":"example_skype"},"role":{"description":"Role","type":"string","enum":["Administrator","User","Guest"],"default":"Administrator","example":"Administrator"},"tfa_secret":{"description":"Tfa Secret","type":"string","format":"password","maxLength":50,"example":"example_tfa_secret"},"floating_noc":{"description":"Floating Noc","type":"integer","nullable":false,"maxLength":3,"minimum":0,"example":1},"language":{"description":"Language","type":"string","maxLength":10,"default":"en","example":"example_language"},"last_login":{"description":"Last Login","type":"string","format":"date-time","nullable":true,"maxLength":6,"example":"2025-01-17T10:30:00Z"},"login_count":{"description":"Login Count","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":10},"mobile_verify":{"description":"Mobile Verify","type":"integer","maxLength":255,"minimum":0,"example":1000},"email_verify":{"description":"Email Verify","type":"integer","maxLength":10,"minimum":0,"example":123},"otp_hash":{"description":"Otp Hash","type":"string","maxLength":255,"example":"example_otp_hash"},"api_key":{"description":"Api Key","type":"string","maxLength":255,"example":"example_api_key"},"timezone":{"description":"Timezone","type":"string","maxLength":50,"example":"example_timezone"},"readonly":{"description":"Readonly","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"email_subscription":{"description":"Email Subscription","type":"string","maxLength":255,"default":"newsletters,system-status,news","example":"example_email_subscription"},"ip_whitelist":{"description":"Ip Whitelist","type":"string","maxLength":255,"example":"example_ip_whitelist"},"share_ticket":{"description":"Share Ticket","type":"integer","nullable":false,"maxLength":255,"minimum":0,"default":"0","example":1},"id_verify":{"description":"Id Verify","type":"string","nullable":false,"maxLength":255,"example":"example_id_verify"},"flags":{"description":"Flags","type":"string","maxLength":255,"example":"example_flags"}},"example":{"id":12345,"account_id":1,"reseller_id":1,"name":"Example Name","email":"user@example.com","password":"********","mobile":"+1-555-123-4567","skype":"example_skype","role":"Administrator","tfa_secret":"example_tfa_secret","floating_noc":1,"language":"example_language","last_login":"2025-01-17T10:30:00Z","login_count":10,"mobile_verify":1000,"email_verify":123,"otp_hash":"example_otp_hash","api_key":"example_api_key","timezone":"example_timezone","readonly":1,"email_subscription":"example_email_subscription","ip_whitelist":"example_ip_whitelist","share_ticket":1,"id_verify":"example_id_verify","flags":"example_flags"}},"setupUserInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":11,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"reseller_id":{"description":"Reseller Id","type":"integer","maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":50,"example":"Example Name"},"email":{"description":"Email (unique)","type":"string","format":"email","maxLength":255,"x-unique":true,"example":"user@example.com"},"password":{"description":"Password","type":"string","format":"password","maxLength":255,"example":"********"},"mobile":{"description":"Mobile","type":"string","maxLength":15,"example":"+1-555-123-4567"},"skype":{"description":"Skype","type":"string","maxLength":50,"example":"example_skype"},"role":{"description":"Role","type":"string","enum":["Administrator","User","Guest"],"default":"Administrator","example":"Administrator"},"tfa_secret":{"description":"Tfa Secret","type":"string","format":"password","maxLength":50,"example":"example_tfa_secret"},"floating_noc":{"description":"Floating Noc","type":"integer","nullable":false,"maxLength":3,"minimum":0,"example":1},"language":{"description":"Language","type":"string","maxLength":10,"default":"en","example":"example_language"},"last_login":{"description":"Last Login","type":"string","format":"date-time","nullable":true,"maxLength":6,"example":"2025-01-17T10:30:00Z"},"login_count":{"description":"Login Count","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":10},"mobile_verify":{"description":"Mobile Verify","type":"integer","maxLength":255,"minimum":0,"example":1000},"email_verify":{"description":"Email Verify","type":"integer","maxLength":10,"minimum":0,"example":123},"otp_hash":{"description":"Otp Hash","type":"string","maxLength":255,"example":"example_otp_hash"},"api_key":{"description":"Api Key","type":"string","maxLength":255,"example":"example_api_key"},"timezone":{"description":"Timezone","type":"string","maxLength":50,"example":"example_timezone"},"readonly":{"description":"Readonly","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"email_subscription":{"description":"Email Subscription","type":"string","maxLength":255,"default":"newsletters,system-status,news","example":"example_email_subscription"},"ip_whitelist":{"description":"Ip Whitelist","type":"string","maxLength":255,"example":"example_ip_whitelist"},"share_ticket":{"description":"Share Ticket","type":"integer","nullable":false,"maxLength":255,"minimum":0,"default":"0","example":1},"id_verify":{"description":"Id Verify","type":"string","nullable":false,"maxLength":255,"example":"example_id_verify"},"flags":{"description":"Flags","type":"string","maxLength":255,"example":"example_flags"}},"example":{"id":12345,"account_id":1,"reseller_id":1,"name":"Example Name","email":"user@example.com","password":"********","mobile":"+1-555-123-4567","skype":"example_skype","role":"Administrator","tfa_secret":"example_tfa_secret","floating_noc":1,"language":"example_language","last_login":"2025-01-17T10:30:00Z","login_count":10,"mobile_verify":1000,"email_verify":123,"otp_hash":"example_otp_hash","api_key":"example_api_key","timezone":"example_timezone","readonly":1,"email_subscription":"example_email_subscription","ip_whitelist":"example_ip_whitelist","share_ticket":1,"id_verify":"example_id_verify","flags":"example_flags"},"required":["name","floating_noc","login_count","readonly","share_ticket","id_verify"]},"setupWebphone":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"brand_name":{"description":"Brand Name","type":"string","maxLength":255,"example":"example_brand_name"},"domain":{"description":"Domain","type":"string","maxLength":255,"example":"example_domain"},"deploy_type":{"description":"Deploy Type","type":"string","enum":["code","sms","existing"],"example":"code"},"signup_fields":{"description":"Signup Fields","type":"string","maxLength":255,"example":"example_signup_fields"},"menu":{"description":"Menu","type":"object","additionalProperties":true,"example":"Sample menu text content"},"register_success_html":{"description":"Register Success Html","type":"string","example":"Sample register_success_html text content"},"host":{"description":"Host","type":"string","maxLength":255,"example":"example_host"},"flags":{"description":"Flags","type":"array","items":{"type":"string","enum":["BALANCE","HIDE_UUID","SIMPLE_ERRORS","MENU_RIGHT","EDIT_SETTINGS","REGISTER","TITLE_USERNAME","ACCEPT_PAYMENT","HIDE_VERSION","PREVIEW_DIALLER","STANDALONE","AUTO_ANSWER","HOLD","TURN","HIDE_SIP_LOGIN","OTP_LOGIN"]},"example":"BALANCE"},"netlify_site_id":{"description":"Netlify Site Id","type":"string","maxLength":100,"example":1},"template_customer_id":{"description":"Template Customer Id","type":"integer","maxLength":10,"minimum":0,"example":1},"customers":{"description":"Customers","type":"string","maxLength":500,"example":"example_customers"},"css":{"description":"Css","type":"string","example":"Sample css text content"},"codec_delete":{"description":"Codec Delete","type":"string","nullable":false,"maxLength":255,"example":"example_codec_delete"},"codec_priority":{"description":"Codec Priority","type":"string","nullable":false,"maxLength":255,"example":"example_codec_priority"}},"example":{"id":12345,"account_id":1,"brand_name":"example_brand_name","domain":"example_domain","deploy_type":"code","signup_fields":"example_signup_fields","menu":"Sample menu text content","register_success_html":"Sample register_success_html text content","host":"example_host","flags":"BALANCE","netlify_site_id":1,"template_customer_id":1,"customers":"example_customers","css":"Sample css text content","codec_delete":"example_codec_delete","codec_priority":"example_codec_priority"}},"setupWebphoneInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"brand_name":{"description":"Brand Name","type":"string","maxLength":255,"example":"example_brand_name"},"domain":{"description":"Domain","type":"string","maxLength":255,"example":"example_domain"},"deploy_type":{"description":"Deploy Type","type":"string","enum":["code","sms","existing"],"example":"code"},"signup_fields":{"description":"Signup Fields","type":"string","maxLength":255,"example":"example_signup_fields"},"menu":{"description":"Menu","type":"object","additionalProperties":true,"example":"Sample menu text content"},"register_success_html":{"description":"Register Success Html","type":"string","example":"Sample register_success_html text content"},"host":{"description":"Host","type":"string","maxLength":255,"example":"example_host"},"flags":{"description":"Flags","type":"array","items":{"type":"string","enum":["BALANCE","HIDE_UUID","SIMPLE_ERRORS","MENU_RIGHT","EDIT_SETTINGS","REGISTER","TITLE_USERNAME","ACCEPT_PAYMENT","HIDE_VERSION","PREVIEW_DIALLER","STANDALONE","AUTO_ANSWER","HOLD","TURN","HIDE_SIP_LOGIN","OTP_LOGIN"]},"example":"BALANCE"},"netlify_site_id":{"description":"Netlify Site Id","type":"string","maxLength":100,"example":1},"template_customer_id":{"description":"Template Customer Id","type":"integer","maxLength":10,"minimum":0,"example":1},"customers":{"description":"Customers","type":"string","maxLength":500,"example":"example_customers"},"css":{"description":"Css","type":"string","example":"Sample css text content"},"codec_delete":{"description":"Codec Delete","type":"string","nullable":false,"maxLength":255,"example":"example_codec_delete"},"codec_priority":{"description":"Codec Priority","type":"string","nullable":false,"maxLength":255,"example":"example_codec_priority"}},"example":{"id":12345,"account_id":1,"brand_name":"example_brand_name","domain":"example_domain","deploy_type":"code","signup_fields":"example_signup_fields","menu":"Sample menu text content","register_success_html":"Sample register_success_html text content","host":"example_host","flags":"BALANCE","netlify_site_id":1,"template_customer_id":1,"customers":"example_customers","css":"Sample css text content","codec_delete":"example_codec_delete","codec_priority":"example_codec_priority"},"required":["codec_delete","codec_priority"]},"class5AiAgentProvider":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"example":12345},"component_type":{"description":"Component Type","type":"string","enum":["asr","tts","llm","s2s","recording","memory","audio_processing","observability"],"nullable":false,"example":"asr"},"provider":{"description":"Provider","type":"string","nullable":false,"maxLength":64,"example":"example_provider"},"name":{"description":"Name","type":"string","nullable":false,"maxLength":128,"example":"Example Name"},"scope":{"description":"Scope","type":"string","enum":["system","user"],"nullable":false,"example":"system"},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"settings":{"description":"Settings","type":"string","example":"Sample settings text content"},"is_default":{"description":"Is Default","type":"integer","nullable":false,"maxLength":1,"default":"0","example":true},"enabled":{"description":"Enabled","type":"integer","nullable":false,"maxLength":1,"default":"1","example":true},"created_at":{"description":"Created At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"updated_at":{"description":"Updated At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"default_slot":{"description":"Default Slot","type":"integer","maxLength":1,"example":1},"model":{"description":"Model","type":"string","maxLength":128,"example":"example_model"},"abstract":{"description":"Abstract","type":"string","maxLength":255,"example":"example_abstract"}},"example":{"id":12345,"component_type":"asr","provider":"example_provider","name":"Example Name","scope":"system","account_id":1,"settings":"Sample settings text content","is_default":true,"enabled":true,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z","default_slot":1,"model":"example_model","abstract":"example_abstract"}},"class5AiAgentProviderInput":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"example":12345},"component_type":{"description":"Component Type","type":"string","enum":["asr","tts","llm","s2s","recording","memory","audio_processing","observability"],"nullable":false,"example":"asr"},"provider":{"description":"Provider","type":"string","nullable":false,"maxLength":64,"example":"example_provider"},"name":{"description":"Name","type":"string","nullable":false,"maxLength":128,"example":"Example Name"},"scope":{"description":"Scope","type":"string","enum":["system","user"],"nullable":false,"example":"system"},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"settings":{"description":"Settings","type":"string","example":"Sample settings text content"},"is_default":{"description":"Is Default","type":"integer","nullable":false,"maxLength":1,"default":"0","example":true},"enabled":{"description":"Enabled","type":"integer","nullable":false,"maxLength":1,"default":"1","example":true},"created_at":{"description":"Created At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"updated_at":{"description":"Updated At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"default_slot":{"description":"Default Slot","type":"integer","maxLength":1,"example":1},"model":{"description":"Model","type":"string","maxLength":128,"example":"example_model"},"abstract":{"description":"Abstract","type":"string","maxLength":255,"example":"example_abstract"}},"example":{"id":12345,"component_type":"asr","provider":"example_provider","name":"Example Name","scope":"system","account_id":1,"settings":"Sample settings text content","is_default":true,"enabled":true,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z","default_slot":1,"model":"example_model","abstract":"example_abstract"},"required":["component_type","provider","name","scope","is_default","enabled"]},"class5AiAgentTest":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":255,"default":"uuid()","example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"agent_id":{"description":"Agent Id (references ai_agent.id)","type":"string","nullable":false,"maxLength":40,"x-foreignKey":{"referencesTable":"ai_agent","referencesColumn":"id"},"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"conversation":{"description":"Conversation","type":"string","example":"Sample conversation text content"},"criteria":{"description":"Criteria","type":"string","example":"Sample criteria text content"}},"example":{"id":12345,"account_id":1,"agent_id":1,"name":"Example Name","conversation":"Sample conversation text content","criteria":"Sample criteria text content"}},"class5AiAgentTestInput":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":255,"default":"uuid()","example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"agent_id":{"description":"Agent Id (references ai_agent.id)","type":"string","nullable":false,"maxLength":40,"x-foreignKey":{"referencesTable":"ai_agent","referencesColumn":"id"},"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"conversation":{"description":"Conversation","type":"string","example":"Sample conversation text content"},"criteria":{"description":"Criteria","type":"string","example":"Sample criteria text content"}},"example":{"id":12345,"account_id":1,"agent_id":1,"name":"Example Name","conversation":"Sample conversation text content","criteria":"Sample criteria text content"},"required":["agent_id","name"]},"class5AiAgent":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":40,"default":"uuid()","example":12345},"account_id":{"description":"Account Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":1},"company_id":{"description":"Company Id","type":"integer","maxLength":10,"minimum":0,"example":1},"app_id":{"description":"App Id","type":"string","maxLength":40,"example":1},"dest":{"description":"Dest","type":"string","maxLength":50,"example":"example_dest"},"host":{"description":"Host","type":"string","maxLength":255,"example":"example_host"},"pbx_server":{"description":"Pbx Server","type":"string","maxLength":255,"example":"example_pbx_server"},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"prompt":{"description":"Prompt","type":"string","example":"Sample prompt text content"},"platform":{"description":"Platform","type":"string","enum":["openai","converse","converse-direct","converse2"],"default":"converse-direct","example":"openai"},"provider":{"description":"Provider","type":"string","maxLength":255,"example":"example_provider"},"model":{"description":"Model","type":"string","maxLength":50,"example":"example_model"},"transcriber":{"description":"Transcriber","type":"string","maxLength":255,"example":"example_transcriber"},"transcriber_model":{"description":"Transcriber Model","type":"string","nullable":false,"maxLength":255,"example":"example_transcriber_model"},"transcriber_silence_threshold":{"description":"Transcriber Silence Threshold","type":"number","maxLength":3,"minimum":0,"example":99.99},"transcriber_language":{"description":"Transcriber Language","type":"string","maxLength":255,"example":"example_transcriber_language"},"tts":{"description":"Tts","type":"string","maxLength":255,"example":"example_tts"},"voice":{"description":"Voice","type":"string","maxLength":255,"example":"example_voice"},"first_message":{"description":"First Message","type":"string","maxLength":500,"example":"example_first_message"},"endpoint_id":{"description":"Endpoint Id","type":"string","maxLength":50,"example":1},"vad":{"description":"Vad","type":"integer","maxLength":3,"minimum":0,"example":1},"early_end_turn_threshold":{"description":"Early End Turn Threshold","type":"number","maxLength":8,"minimum":0,"example":99.99},"end_turn_threshold":{"description":"End Turn Threshold","type":"number","nullable":false,"maxLength":8,"minimum":0,"default":"0","example":99.99},"temperature":{"description":"Temperature","type":"number","maxLength":2,"minimum":0,"default":"1","example":99.99},"built_in_functions":{"description":"Built In Functions","type":"string","maxLength":255,"example":"example_built_in_functions"},"end_call_phrases":{"description":"End Call Phrases","type":"string","maxLength":255,"example":"example_end_call_phrases"},"interrupt_delay":{"description":"Interrupt Delay","type":"number","maxLength":2,"minimum":0,"example":99.99},"guard_rails":{"description":"Guard Rails","type":"string","maxLength":255,"example":"example_guard_rails"},"filler_words":{"description":"Filler Words","type":"string","maxLength":255,"example":"example_filler_words"},"min_filler_word_delay":{"description":"Min Filler Word Delay","type":"number","maxLength":3,"minimum":0,"example":99.99},"office_background_volume":{"description":"Office Background Volume","type":"number","maxLength":2,"minimum":0,"example":99.99},"flags":{"description":"Flags","type":"array","items":{"type":"string","enum":["ASYNC_GUARD_RAILS","LOCAL_VAD","LLM_FAILOVER","DISABLE_SCRIPTFORGE","LISTEN_FIRST","COMPLETE_WORD_ON_INTERUPT","VAD_START_INTERUPT","ASYNC_FIRST_GREETING_EXEC"]},"nullable":false,"default":"","example":"ASYNC_GUARD_RAILS"},"llm_timeout":{"description":"Llm Timeout","type":"number","maxLength":3,"minimum":0,"default":"1","example":99.99},"llm_retries":{"description":"Llm Retries","type":"integer","maxLength":3,"minimum":0,"default":"2","example":1},"amd_keywords":{"description":"Amd Keywords","type":"string","maxLength":5000,"example":"example_amd_keywords"},"vars":{"description":"Vars","type":"string","maxLength":1000,"example":"example_vars"},"transcriber_timeout":{"description":"Transcriber Timeout","type":"integer","maxLength":3,"minimum":0,"example":1},"tool_call_allow_list":{"description":"Tool Call Allow List","type":"string","maxLength":1000,"example":"example_tool_call_allow_list"},"precache_phrases":{"description":"Precache Phrases","type":"string","maxLength":5000,"example":"example_precache_phrases"},"first_task_id":{"description":"First Task Id","type":"string","maxLength":40,"example":1},"kb_id":{"description":"Kb Id","type":"string","maxLength":40,"example":1},"asr_provider_config_id":{"description":"Asr Provider Config Id (references converse_provider_config.id)","type":"string","x-foreignKey":{"referencesTable":"converse_provider_config","referencesColumn":"id"},"example":1},"llm_provider_config_id":{"description":"Llm Provider Config Id (references converse_provider_config.id)","type":"string","x-foreignKey":{"referencesTable":"converse_provider_config","referencesColumn":"id"},"example":1},"tts_provider_config_id":{"description":"Tts Provider Config Id (references converse_provider_config.id)","type":"string","x-foreignKey":{"referencesTable":"converse_provider_config","referencesColumn":"id"},"example":1},"s2s_provider_config_id":{"description":"S 2 S Provider Config Id (references converse_provider_config.id)","type":"string","x-foreignKey":{"referencesTable":"converse_provider_config","referencesColumn":"id"},"example":1},"mcp_servers":{"description":"Mcp Servers","type":"object","additionalProperties":true,"example":"Sample mcp_servers text content"}},"example":{"id":12345,"account_id":1,"company_id":1,"app_id":1,"dest":"example_dest","host":"example_host","pbx_server":"example_pbx_server","name":"Example Name","prompt":"Sample prompt text content","platform":"openai","provider":"example_provider","model":"example_model","transcriber":"example_transcriber","transcriber_model":"example_transcriber_model","transcriber_silence_threshold":99.99,"transcriber_language":"example_transcriber_language","tts":"example_tts","voice":"example_voice","first_message":"example_first_message","endpoint_id":1,"vad":1,"early_end_turn_threshold":99.99,"end_turn_threshold":99.99,"temperature":99.99,"built_in_functions":"example_built_in_functions","end_call_phrases":"example_end_call_phrases","interrupt_delay":99.99,"guard_rails":"example_guard_rails","filler_words":"example_filler_words","min_filler_word_delay":99.99,"office_background_volume":99.99,"flags":"ASYNC_GUARD_RAILS","llm_timeout":99.99,"llm_retries":1,"amd_keywords":"example_amd_keywords","vars":"example_vars","transcriber_timeout":1,"tool_call_allow_list":"example_tool_call_allow_list","precache_phrases":"example_precache_phrases","first_task_id":1,"kb_id":1,"asr_provider_config_id":1,"llm_provider_config_id":1,"tts_provider_config_id":1,"s2s_provider_config_id":1,"mcp_servers":"Sample mcp_servers text content"}},"class5AiAgentInput":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":40,"default":"uuid()","example":12345},"account_id":{"description":"Account Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":1},"company_id":{"description":"Company Id","type":"integer","maxLength":10,"minimum":0,"example":1},"app_id":{"description":"App Id","type":"string","maxLength":40,"example":1},"dest":{"description":"Dest","type":"string","maxLength":50,"example":"example_dest"},"host":{"description":"Host","type":"string","maxLength":255,"example":"example_host"},"pbx_server":{"description":"Pbx Server","type":"string","maxLength":255,"example":"example_pbx_server"},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"prompt":{"description":"Prompt","type":"string","example":"Sample prompt text content"},"platform":{"description":"Platform","type":"string","enum":["openai","converse","converse-direct","converse2"],"default":"converse-direct","example":"openai"},"provider":{"description":"Provider","type":"string","maxLength":255,"example":"example_provider"},"model":{"description":"Model","type":"string","maxLength":50,"example":"example_model"},"transcriber":{"description":"Transcriber","type":"string","maxLength":255,"example":"example_transcriber"},"transcriber_model":{"description":"Transcriber Model","type":"string","nullable":false,"maxLength":255,"example":"example_transcriber_model"},"transcriber_silence_threshold":{"description":"Transcriber Silence Threshold","type":"number","maxLength":3,"minimum":0,"example":99.99},"transcriber_language":{"description":"Transcriber Language","type":"string","maxLength":255,"example":"example_transcriber_language"},"tts":{"description":"Tts","type":"string","maxLength":255,"example":"example_tts"},"voice":{"description":"Voice","type":"string","maxLength":255,"example":"example_voice"},"first_message":{"description":"First Message","type":"string","maxLength":500,"example":"example_first_message"},"endpoint_id":{"description":"Endpoint Id","type":"string","maxLength":50,"example":1},"vad":{"description":"Vad","type":"integer","maxLength":3,"minimum":0,"example":1},"early_end_turn_threshold":{"description":"Early End Turn Threshold","type":"number","maxLength":8,"minimum":0,"example":99.99},"end_turn_threshold":{"description":"End Turn Threshold","type":"number","nullable":false,"maxLength":8,"minimum":0,"default":"0","example":99.99},"temperature":{"description":"Temperature","type":"number","maxLength":2,"minimum":0,"default":"1","example":99.99},"built_in_functions":{"description":"Built In Functions","type":"string","maxLength":255,"example":"example_built_in_functions"},"end_call_phrases":{"description":"End Call Phrases","type":"string","maxLength":255,"example":"example_end_call_phrases"},"interrupt_delay":{"description":"Interrupt Delay","type":"number","maxLength":2,"minimum":0,"example":99.99},"guard_rails":{"description":"Guard Rails","type":"string","maxLength":255,"example":"example_guard_rails"},"filler_words":{"description":"Filler Words","type":"string","maxLength":255,"example":"example_filler_words"},"min_filler_word_delay":{"description":"Min Filler Word Delay","type":"number","maxLength":3,"minimum":0,"example":99.99},"office_background_volume":{"description":"Office Background Volume","type":"number","maxLength":2,"minimum":0,"example":99.99},"flags":{"description":"Flags","type":"array","items":{"type":"string","enum":["ASYNC_GUARD_RAILS","LOCAL_VAD","LLM_FAILOVER","DISABLE_SCRIPTFORGE","LISTEN_FIRST","COMPLETE_WORD_ON_INTERUPT","VAD_START_INTERUPT","ASYNC_FIRST_GREETING_EXEC"]},"nullable":false,"default":"","example":"ASYNC_GUARD_RAILS"},"llm_timeout":{"description":"Llm Timeout","type":"number","maxLength":3,"minimum":0,"default":"1","example":99.99},"llm_retries":{"description":"Llm Retries","type":"integer","maxLength":3,"minimum":0,"default":"2","example":1},"amd_keywords":{"description":"Amd Keywords","type":"string","maxLength":5000,"example":"example_amd_keywords"},"vars":{"description":"Vars","type":"string","maxLength":1000,"example":"example_vars"},"transcriber_timeout":{"description":"Transcriber Timeout","type":"integer","maxLength":3,"minimum":0,"example":1},"tool_call_allow_list":{"description":"Tool Call Allow List","type":"string","maxLength":1000,"example":"example_tool_call_allow_list"},"precache_phrases":{"description":"Precache Phrases","type":"string","maxLength":5000,"example":"example_precache_phrases"},"first_task_id":{"description":"First Task Id","type":"string","maxLength":40,"example":1},"kb_id":{"description":"Kb Id","type":"string","maxLength":40,"example":1},"asr_provider_config_id":{"description":"Asr Provider Config Id (references converse_provider_config.id)","type":"string","x-foreignKey":{"referencesTable":"converse_provider_config","referencesColumn":"id"},"example":1},"llm_provider_config_id":{"description":"Llm Provider Config Id (references converse_provider_config.id)","type":"string","x-foreignKey":{"referencesTable":"converse_provider_config","referencesColumn":"id"},"example":1},"tts_provider_config_id":{"description":"Tts Provider Config Id (references converse_provider_config.id)","type":"string","x-foreignKey":{"referencesTable":"converse_provider_config","referencesColumn":"id"},"example":1},"s2s_provider_config_id":{"description":"S 2 S Provider Config Id (references converse_provider_config.id)","type":"string","x-foreignKey":{"referencesTable":"converse_provider_config","referencesColumn":"id"},"example":1},"mcp_servers":{"description":"Mcp Servers","type":"object","additionalProperties":true,"example":"Sample mcp_servers text content"}},"example":{"id":12345,"account_id":1,"company_id":1,"app_id":1,"dest":"example_dest","host":"example_host","pbx_server":"example_pbx_server","name":"Example Name","prompt":"Sample prompt text content","platform":"openai","provider":"example_provider","model":"example_model","transcriber":"example_transcriber","transcriber_model":"example_transcriber_model","transcriber_silence_threshold":99.99,"transcriber_language":"example_transcriber_language","tts":"example_tts","voice":"example_voice","first_message":"example_first_message","endpoint_id":1,"vad":1,"early_end_turn_threshold":99.99,"end_turn_threshold":99.99,"temperature":99.99,"built_in_functions":"example_built_in_functions","end_call_phrases":"example_end_call_phrases","interrupt_delay":99.99,"guard_rails":"example_guard_rails","filler_words":"example_filler_words","min_filler_word_delay":99.99,"office_background_volume":99.99,"flags":"ASYNC_GUARD_RAILS","llm_timeout":99.99,"llm_retries":1,"amd_keywords":"example_amd_keywords","vars":"example_vars","transcriber_timeout":1,"tool_call_allow_list":"example_tool_call_allow_list","precache_phrases":"example_precache_phrases","first_task_id":1,"kb_id":1,"asr_provider_config_id":1,"llm_provider_config_id":1,"tts_provider_config_id":1,"s2s_provider_config_id":1,"mcp_servers":"Sample mcp_servers text content"},"required":["name","transcriber_model","end_turn_threshold","flags"]},"class5App":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":11,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"company_id":{"description":"Company Id","type":"integer","maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"app_type":{"description":"App Type","type":"string","enum":["connexml","legacy","callflow"],"example":"connexml"},"dest":{"description":"Dest","type":"string","maxLength":255,"example":"example_dest"},"allow":{"description":"Allow","type":"string","maxLength":5000,"example":"example_allow"},"deny":{"description":"Deny","type":"string","maxLength":5000,"example":"example_deny"},"data":{"description":"Data","type":"string","example":"Sample data text content"},"pbx_server":{"description":"Pbx Server","type":"string","maxLength":255,"default":"pbx.connexcs.com","example":"example_pbx_server"},"xml":{"description":"Xml","type":"string","example":"Sample xml text content"}},"example":{"id":12345,"account_id":1,"company_id":1,"name":"Example Name","app_type":"connexml","dest":"example_dest","allow":"example_allow","deny":"example_deny","data":"Sample data text content","pbx_server":"example_pbx_server","xml":"Sample xml text content"}},"class5AppInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":11,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"company_id":{"description":"Company Id","type":"integer","maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"app_type":{"description":"App Type","type":"string","enum":["connexml","legacy","callflow"],"example":"connexml"},"dest":{"description":"Dest","type":"string","maxLength":255,"example":"example_dest"},"allow":{"description":"Allow","type":"string","maxLength":5000,"example":"example_allow"},"deny":{"description":"Deny","type":"string","maxLength":5000,"example":"example_deny"},"data":{"description":"Data","type":"string","example":"Sample data text content"},"pbx_server":{"description":"Pbx Server","type":"string","maxLength":255,"default":"pbx.connexcs.com","example":"example_pbx_server"},"xml":{"description":"Xml","type":"string","example":"Sample xml text content"}},"example":{"id":12345,"account_id":1,"company_id":1,"name":"Example Name","app_type":"connexml","dest":"example_dest","allow":"example_allow","deny":"example_deny","data":"Sample data text content","pbx_server":"example_pbx_server","xml":"Sample xml text content"},"required":["name"]},"class5Audio":{"type":"object","properties":{"category":{"description":"Category","type":"string","nullable":false,"maxLength":100,"example":"example_category"},"name":{"description":"Name","type":"string","nullable":false,"maxLength":100,"example":"Example Name"}},"example":{"category":"example_category","name":"Example Name"}},"class5CallCenter":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":36,"default":"","example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"company_id":{"description":"Company Id","type":"integer","maxLength":10,"minimum":0,"example":1},"pbx_server":{"description":"Pbx Server","type":"string","nullable":false,"maxLength":255,"example":"example_pbx_server"},"c4_server":{"description":"C 4 Server","type":"string","maxLength":255,"example":"example_c4_server"},"name":{"description":"Name","type":"string","nullable":false,"maxLength":255,"example":"Example Name"},"dest":{"description":"Dest","type":"string","maxLength":100,"example":"example_dest"},"strategy":{"description":"Strategy","type":"string","enum":["ring-all","longest-idle-agent","round-robin","top-down","agent-with-least-talk-time","agent-with-fewest-calls","sequentially-by-agent-order","random","ring-progressively"],"nullable":false,"default":"ring-all","example":"ring-all"},"moh_sound":{"description":"Moh Sound","type":"string","nullable":false,"maxLength":255,"example":"example_moh_sound"},"record_template":{"description":"Record Template","type":"string","maxLength":255,"example":"example_record_template"},"time_base_score":{"description":"Time Base Score","type":"string","enum":["system","queue"],"nullable":false,"default":"queue","example":"system"},"max_wait_time":{"description":"Max Wait Time","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":123},"max_wait_time_with_no_agent":{"description":"Max Wait Time With No Agent","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":123},"max_wait_time_with_no_agent_time_reached":{"description":"Max Wait Time With No Agent Time Reached","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"5","example":123},"agent_no_answer_status":{"description":"Agent No Answer Status","type":"string","enum":["Available","Available (On Demand"],"example":"Available"},"tier_rules_apply":{"description":"Tier Rules Apply","type":"integer","nullable":false,"maxLength":1,"minimum":0,"default":"0","example":1},"tier_rule_wait_second":{"description":"Tier Rule Wait Second","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":123},"tier_rule_wait_multiply_level":{"description":"Tier Rule Wait Multiply Level","type":"integer","nullable":false,"maxLength":1,"minimum":0,"default":"0","example":1},"tier_rule_no_agent_no_wait":{"description":"Tier Rule No Agent No Wait","type":"integer","nullable":false,"maxLength":1,"minimum":0,"default":"0","example":1},"discard_abandoned_after":{"description":"Discard Abandoned After","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":123},"abandoned_resume_allowed":{"description":"Abandoned Resume Allowed","type":"integer","nullable":false,"maxLength":1,"minimum":0,"default":"0","example":1},"failover_dest":{"description":"Failover Dest","type":"string","maxLength":255,"example":"example_failover_dest"},"failover_dest_type":{"description":"Failover Dest Type","type":"string","enum":["internal","external"],"default":"internal","example":"internal"},"created_at":{"description":"Created At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"updated_at":{"description":"Updated At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"}},"example":{"id":12345,"account_id":1,"company_id":1,"pbx_server":"example_pbx_server","c4_server":"example_c4_server","name":"Example Name","dest":"example_dest","strategy":"ring-all","moh_sound":"example_moh_sound","record_template":"example_record_template","time_base_score":"system","max_wait_time":123,"max_wait_time_with_no_agent":123,"max_wait_time_with_no_agent_time_reached":123,"agent_no_answer_status":"Available","tier_rules_apply":1,"tier_rule_wait_second":123,"tier_rule_wait_multiply_level":1,"tier_rule_no_agent_no_wait":1,"discard_abandoned_after":123,"abandoned_resume_allowed":1,"failover_dest":"example_failover_dest","failover_dest_type":"internal","created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"}},"class5CallCenterInput":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":36,"default":"","example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"company_id":{"description":"Company Id","type":"integer","maxLength":10,"minimum":0,"example":1},"pbx_server":{"description":"Pbx Server","type":"string","nullable":false,"maxLength":255,"example":"example_pbx_server"},"c4_server":{"description":"C 4 Server","type":"string","maxLength":255,"example":"example_c4_server"},"name":{"description":"Name","type":"string","nullable":false,"maxLength":255,"example":"Example Name"},"dest":{"description":"Dest","type":"string","maxLength":100,"example":"example_dest"},"strategy":{"description":"Strategy","type":"string","enum":["ring-all","longest-idle-agent","round-robin","top-down","agent-with-least-talk-time","agent-with-fewest-calls","sequentially-by-agent-order","random","ring-progressively"],"nullable":false,"default":"ring-all","example":"ring-all"},"moh_sound":{"description":"Moh Sound","type":"string","nullable":false,"maxLength":255,"example":"example_moh_sound"},"record_template":{"description":"Record Template","type":"string","maxLength":255,"example":"example_record_template"},"time_base_score":{"description":"Time Base Score","type":"string","enum":["system","queue"],"nullable":false,"default":"queue","example":"system"},"max_wait_time":{"description":"Max Wait Time","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":123},"max_wait_time_with_no_agent":{"description":"Max Wait Time With No Agent","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":123},"max_wait_time_with_no_agent_time_reached":{"description":"Max Wait Time With No Agent Time Reached","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"5","example":123},"agent_no_answer_status":{"description":"Agent No Answer Status","type":"string","enum":["Available","Available (On Demand"],"example":"Available"},"tier_rules_apply":{"description":"Tier Rules Apply","type":"integer","nullable":false,"maxLength":1,"minimum":0,"default":"0","example":1},"tier_rule_wait_second":{"description":"Tier Rule Wait Second","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":123},"tier_rule_wait_multiply_level":{"description":"Tier Rule Wait Multiply Level","type":"integer","nullable":false,"maxLength":1,"minimum":0,"default":"0","example":1},"tier_rule_no_agent_no_wait":{"description":"Tier Rule No Agent No Wait","type":"integer","nullable":false,"maxLength":1,"minimum":0,"default":"0","example":1},"discard_abandoned_after":{"description":"Discard Abandoned After","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":123},"abandoned_resume_allowed":{"description":"Abandoned Resume Allowed","type":"integer","nullable":false,"maxLength":1,"minimum":0,"default":"0","example":1},"failover_dest":{"description":"Failover Dest","type":"string","maxLength":255,"example":"example_failover_dest"},"failover_dest_type":{"description":"Failover Dest Type","type":"string","enum":["internal","external"],"default":"internal","example":"internal"},"created_at":{"description":"Created At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"updated_at":{"description":"Updated At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"}},"example":{"id":12345,"account_id":1,"company_id":1,"pbx_server":"example_pbx_server","c4_server":"example_c4_server","name":"Example Name","dest":"example_dest","strategy":"ring-all","moh_sound":"example_moh_sound","record_template":"example_record_template","time_base_score":"system","max_wait_time":123,"max_wait_time_with_no_agent":123,"max_wait_time_with_no_agent_time_reached":123,"agent_no_answer_status":"Available","tier_rules_apply":1,"tier_rule_wait_second":123,"tier_rule_wait_multiply_level":1,"tier_rule_no_agent_no_wait":1,"discard_abandoned_after":123,"abandoned_resume_allowed":1,"failover_dest":"example_failover_dest","failover_dest_type":"internal","created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"},"required":["pbx_server","name","strategy","moh_sound","time_base_score","max_wait_time","max_wait_time_with_no_agent","max_wait_time_with_no_agent_time_reached","tier_rules_apply","tier_rule_wait_second","tier_rule_wait_multiply_level","tier_rule_no_agent_no_wait","discard_abandoned_after","abandoned_resume_allowed"]},"class5Conference":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":11,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"customer_id":{"description":"Customer Id","type":"integer","maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"dest":{"description":"Dest","type":"string","maxLength":255,"example":"example_dest"},"pin":{"description":"Pin","type":"string","maxLength":10,"example":"example_pin"},"moderator_pin":{"description":"Moderator Pin","type":"string","maxLength":10,"example":"example_moderator_pin"},"quality":{"description":"Quality","type":"string","maxLength":20,"example":"example_quality"},"max_members":{"description":"Max Members","type":"integer","maxLength":10,"minimum":0,"example":123},"pbx_server":{"description":"Pbx Server","type":"string","maxLength":255,"default":"pbx.connexcs.com","example":"example_pbx_server"}},"example":{"id":12345,"account_id":1,"customer_id":1,"name":"Example Name","dest":"example_dest","pin":"example_pin","moderator_pin":"example_moderator_pin","quality":"example_quality","max_members":123,"pbx_server":"example_pbx_server"}},"class5ConferenceInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":11,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"customer_id":{"description":"Customer Id","type":"integer","maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"dest":{"description":"Dest","type":"string","maxLength":255,"example":"example_dest"},"pin":{"description":"Pin","type":"string","maxLength":10,"example":"example_pin"},"moderator_pin":{"description":"Moderator Pin","type":"string","maxLength":10,"example":"example_moderator_pin"},"quality":{"description":"Quality","type":"string","maxLength":20,"example":"example_quality"},"max_members":{"description":"Max Members","type":"integer","maxLength":10,"minimum":0,"example":123},"pbx_server":{"description":"Pbx Server","type":"string","maxLength":255,"default":"pbx.connexcs.com","example":"example_pbx_server"}},"example":{"id":12345,"account_id":1,"customer_id":1,"name":"Example Name","dest":"example_dest","pin":"example_pin","moderator_pin":"example_moderator_pin","quality":"example_quality","max_members":123,"pbx_server":"example_pbx_server"},"required":["name"]},"class5Directory":{"type":"object","properties":{}},"class5Group":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"customer_id":{"description":"Customer Id","type":"integer","maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"dest":{"description":"Dest","type":"string","maxLength":255,"example":"example_dest"},"agent_login_dest":{"description":"Agent Login Dest","type":"string","maxLength":255,"example":"example_agent_login_dest"},"agent_logout_dest":{"description":"Agent Logout Dest","type":"string","maxLength":255,"example":"example_agent_logout_dest"},"agent_offhook_dest":{"description":"Agent Offhook Dest","type":"string","maxLength":255,"example":"example_agent_offhook_dest"},"distribution_method":{"description":"Distribution Method","type":"string","enum":["parallel","sequential","queue"],"default":"parallel","example":"parallel"},"server_affinity":{"description":"Server Affinity","type":"string","maxLength":15,"example":"example_server_affinity"},"on_hold_music":{"description":"On Hold Music","type":"string","maxLength":255,"example":"example_on_hold_music"},"join_message":{"description":"Join Message","type":"string","maxLength":255,"example":"example_join_message"},"chime_list":{"description":"Chime List","type":"string","maxLength":255,"example":"example_chime_list"},"chime_interval":{"description":"Chime Interval","type":"integer","maxLength":3,"minimum":0,"example":1},"pbx_server":{"description":"Pbx Server","type":"string","maxLength":255,"default":"pbx.connexcs.com","example":"example_pbx_server"}},"example":{"id":12345,"account_id":1,"customer_id":1,"name":"Example Name","dest":"example_dest","agent_login_dest":"example_agent_login_dest","agent_logout_dest":"example_agent_logout_dest","agent_offhook_dest":"example_agent_offhook_dest","distribution_method":"parallel","server_affinity":"example_server_affinity","on_hold_music":"example_on_hold_music","join_message":"example_join_message","chime_list":"example_chime_list","chime_interval":1,"pbx_server":"example_pbx_server"}},"class5GroupInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"customer_id":{"description":"Customer Id","type":"integer","maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"dest":{"description":"Dest","type":"string","maxLength":255,"example":"example_dest"},"agent_login_dest":{"description":"Agent Login Dest","type":"string","maxLength":255,"example":"example_agent_login_dest"},"agent_logout_dest":{"description":"Agent Logout Dest","type":"string","maxLength":255,"example":"example_agent_logout_dest"},"agent_offhook_dest":{"description":"Agent Offhook Dest","type":"string","maxLength":255,"example":"example_agent_offhook_dest"},"distribution_method":{"description":"Distribution Method","type":"string","enum":["parallel","sequential","queue"],"default":"parallel","example":"parallel"},"server_affinity":{"description":"Server Affinity","type":"string","maxLength":15,"example":"example_server_affinity"},"on_hold_music":{"description":"On Hold Music","type":"string","maxLength":255,"example":"example_on_hold_music"},"join_message":{"description":"Join Message","type":"string","maxLength":255,"example":"example_join_message"},"chime_list":{"description":"Chime List","type":"string","maxLength":255,"example":"example_chime_list"},"chime_interval":{"description":"Chime Interval","type":"integer","maxLength":3,"minimum":0,"example":1},"pbx_server":{"description":"Pbx Server","type":"string","maxLength":255,"default":"pbx.connexcs.com","example":"example_pbx_server"}},"example":{"id":12345,"account_id":1,"customer_id":1,"name":"Example Name","dest":"example_dest","agent_login_dest":"example_agent_login_dest","agent_logout_dest":"example_agent_logout_dest","agent_offhook_dest":"example_agent_offhook_dest","distribution_method":"parallel","server_affinity":"example_server_affinity","on_hold_music":"example_on_hold_music","join_message":"example_join_message","chime_list":"example_chime_list","chime_interval":1,"pbx_server":"example_pbx_server"},"required":["name"]},"class5Ivr":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"customer_id":{"description":"Customer Id","type":"integer","maxLength":10,"minimum":0,"example":1},"dest":{"description":"Dest","type":"string","maxLength":255,"example":"example_dest"},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"invalid_file":{"description":"Invalid File","type":"string","maxLength":255,"example":"example_invalid_file"},"file":{"description":"File","type":"string","maxLength":255,"example":"example_file"},"key_0_destination":{"description":"Key 0 Destination","type":"string","maxLength":50,"example":"example_key_0_destination"},"key_0_destination_type":{"description":"Key 0 Destination Type","type":"string","maxLength":30,"example":"example_key_0_destination_type"},"key_1_destination":{"description":"Key 1 Destination","type":"string","maxLength":50,"example":"example_key_1_destination"},"key_1_destination_type":{"description":"Key 1 Destination Type","type":"string","maxLength":30,"example":"example_key_1_destination_type"},"key_2_destination":{"description":"Key 2 Destination","type":"string","maxLength":50,"example":"example_key_2_destination"},"key_2_destination_type":{"description":"Key 2 Destination Type","type":"string","maxLength":30,"example":"example_key_2_destination_type"},"key_3_destination":{"description":"Key 3 Destination","type":"string","maxLength":50,"example":"example_key_3_destination"},"key_3_destination_type":{"description":"Key 3 Destination Type","type":"string","maxLength":30,"example":"example_key_3_destination_type"},"key_4_destination":{"description":"Key 4 Destination","type":"string","maxLength":50,"example":"example_key_4_destination"},"key_4_destination_type":{"description":"Key 4 Destination Type","type":"string","maxLength":30,"example":"example_key_4_destination_type"},"key_5_destination":{"description":"Key 5 Destination","type":"string","maxLength":50,"example":"example_key_5_destination"},"key_5_destination_type":{"description":"Key 5 Destination Type","type":"string","maxLength":30,"example":"example_key_5_destination_type"},"key_6_destination":{"description":"Key 6 Destination","type":"string","maxLength":50,"example":"example_key_6_destination"},"key_6_destination_type":{"description":"Key 6 Destination Type","type":"string","maxLength":30,"example":"example_key_6_destination_type"},"key_7_destination":{"description":"Key 7 Destination","type":"string","maxLength":50,"example":"example_key_7_destination"},"key_7_destination_type":{"description":"Key 7 Destination Type","type":"string","maxLength":30,"example":"example_key_7_destination_type"},"key_8_destination":{"description":"Key 8 Destination","type":"string","maxLength":50,"example":"example_key_8_destination"},"key_8_destination_type":{"description":"Key 8 Destination Type","type":"string","maxLength":30,"example":"example_key_8_destination_type"},"key_9_destination":{"description":"Key 9 Destination","type":"string","maxLength":50,"example":"example_key_9_destination"},"key_9_destination_type":{"description":"Key 9 Destination Type","type":"string","maxLength":30,"example":"example_key_9_destination_type"},"key_plus_destination":{"description":"Key Plus Destination","type":"string","maxLength":50,"example":"example_key_plus_destination"},"key_plus_destination_type":{"description":"Key Plus Destination Type","type":"string","maxLength":30,"example":"example_key_plus_destination_type"},"key_hash_destination":{"description":"Key Hash Destination","type":"string","maxLength":50,"example":"example_key_hash_destination"},"key_hash_destination_type":{"description":"Key Hash Destination Type","type":"string","maxLength":30,"example":"example_key_hash_destination_type"},"pbx_server":{"description":"Pbx Server","type":"string","maxLength":255,"default":"pbx.connexcs.com","example":"example_pbx_server"},"direct_extension_dial":{"description":"Direct Extension Dial","type":"integer","maxLength":1,"minimum":0,"default":"0","example":1}},"example":{"id":12345,"account_id":1,"customer_id":1,"dest":"example_dest","name":"Example Name","invalid_file":"example_invalid_file","file":"example_file","key_0_destination":"example_key_0_destination","key_0_destination_type":"example_key_0_destination_type","key_1_destination":"example_key_1_destination","key_1_destination_type":"example_key_1_destination_type","key_2_destination":"example_key_2_destination","key_2_destination_type":"example_key_2_destination_type","key_3_destination":"example_key_3_destination","key_3_destination_type":"example_key_3_destination_type","key_4_destination":"example_key_4_destination","key_4_destination_type":"example_key_4_destination_type","key_5_destination":"example_key_5_destination","key_5_destination_type":"example_key_5_destination_type","key_6_destination":"example_key_6_destination","key_6_destination_type":"example_key_6_destination_type","key_7_destination":"example_key_7_destination","key_7_destination_type":"example_key_7_destination_type","key_8_destination":"example_key_8_destination","key_8_destination_type":"example_key_8_destination_type","key_9_destination":"example_key_9_destination","key_9_destination_type":"example_key_9_destination_type","key_plus_destination":"example_key_plus_destination","key_plus_destination_type":"example_key_plus_destination_type","key_hash_destination":"example_key_hash_destination","key_hash_destination_type":"example_key_hash_destination_type","pbx_server":"example_pbx_server","direct_extension_dial":1}},"class5IvrInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id (references account.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"account","referencesColumn":"id"},"example":1},"customer_id":{"description":"Customer Id","type":"integer","maxLength":10,"minimum":0,"example":1},"dest":{"description":"Dest","type":"string","maxLength":255,"example":"example_dest"},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"invalid_file":{"description":"Invalid File","type":"string","maxLength":255,"example":"example_invalid_file"},"file":{"description":"File","type":"string","maxLength":255,"example":"example_file"},"key_0_destination":{"description":"Key 0 Destination","type":"string","maxLength":50,"example":"example_key_0_destination"},"key_0_destination_type":{"description":"Key 0 Destination Type","type":"string","maxLength":30,"example":"example_key_0_destination_type"},"key_1_destination":{"description":"Key 1 Destination","type":"string","maxLength":50,"example":"example_key_1_destination"},"key_1_destination_type":{"description":"Key 1 Destination Type","type":"string","maxLength":30,"example":"example_key_1_destination_type"},"key_2_destination":{"description":"Key 2 Destination","type":"string","maxLength":50,"example":"example_key_2_destination"},"key_2_destination_type":{"description":"Key 2 Destination Type","type":"string","maxLength":30,"example":"example_key_2_destination_type"},"key_3_destination":{"description":"Key 3 Destination","type":"string","maxLength":50,"example":"example_key_3_destination"},"key_3_destination_type":{"description":"Key 3 Destination Type","type":"string","maxLength":30,"example":"example_key_3_destination_type"},"key_4_destination":{"description":"Key 4 Destination","type":"string","maxLength":50,"example":"example_key_4_destination"},"key_4_destination_type":{"description":"Key 4 Destination Type","type":"string","maxLength":30,"example":"example_key_4_destination_type"},"key_5_destination":{"description":"Key 5 Destination","type":"string","maxLength":50,"example":"example_key_5_destination"},"key_5_destination_type":{"description":"Key 5 Destination Type","type":"string","maxLength":30,"example":"example_key_5_destination_type"},"key_6_destination":{"description":"Key 6 Destination","type":"string","maxLength":50,"example":"example_key_6_destination"},"key_6_destination_type":{"description":"Key 6 Destination Type","type":"string","maxLength":30,"example":"example_key_6_destination_type"},"key_7_destination":{"description":"Key 7 Destination","type":"string","maxLength":50,"example":"example_key_7_destination"},"key_7_destination_type":{"description":"Key 7 Destination Type","type":"string","maxLength":30,"example":"example_key_7_destination_type"},"key_8_destination":{"description":"Key 8 Destination","type":"string","maxLength":50,"example":"example_key_8_destination"},"key_8_destination_type":{"description":"Key 8 Destination Type","type":"string","maxLength":30,"example":"example_key_8_destination_type"},"key_9_destination":{"description":"Key 9 Destination","type":"string","maxLength":50,"example":"example_key_9_destination"},"key_9_destination_type":{"description":"Key 9 Destination Type","type":"string","maxLength":30,"example":"example_key_9_destination_type"},"key_plus_destination":{"description":"Key Plus Destination","type":"string","maxLength":50,"example":"example_key_plus_destination"},"key_plus_destination_type":{"description":"Key Plus Destination Type","type":"string","maxLength":30,"example":"example_key_plus_destination_type"},"key_hash_destination":{"description":"Key Hash Destination","type":"string","maxLength":50,"example":"example_key_hash_destination"},"key_hash_destination_type":{"description":"Key Hash Destination Type","type":"string","maxLength":30,"example":"example_key_hash_destination_type"},"pbx_server":{"description":"Pbx Server","type":"string","maxLength":255,"default":"pbx.connexcs.com","example":"example_pbx_server"},"direct_extension_dial":{"description":"Direct Extension Dial","type":"integer","maxLength":1,"minimum":0,"default":"0","example":1}},"example":{"id":12345,"account_id":1,"customer_id":1,"dest":"example_dest","name":"Example Name","invalid_file":"example_invalid_file","file":"example_file","key_0_destination":"example_key_0_destination","key_0_destination_type":"example_key_0_destination_type","key_1_destination":"example_key_1_destination","key_1_destination_type":"example_key_1_destination_type","key_2_destination":"example_key_2_destination","key_2_destination_type":"example_key_2_destination_type","key_3_destination":"example_key_3_destination","key_3_destination_type":"example_key_3_destination_type","key_4_destination":"example_key_4_destination","key_4_destination_type":"example_key_4_destination_type","key_5_destination":"example_key_5_destination","key_5_destination_type":"example_key_5_destination_type","key_6_destination":"example_key_6_destination","key_6_destination_type":"example_key_6_destination_type","key_7_destination":"example_key_7_destination","key_7_destination_type":"example_key_7_destination_type","key_8_destination":"example_key_8_destination","key_8_destination_type":"example_key_8_destination_type","key_9_destination":"example_key_9_destination","key_9_destination_type":"example_key_9_destination_type","key_plus_destination":"example_key_plus_destination","key_plus_destination_type":"example_key_plus_destination_type","key_hash_destination":"example_key_hash_destination","key_hash_destination_type":"example_key_hash_destination_type","pbx_server":"example_pbx_server","direct_extension_dial":1},"required":["name"]},"class5SystemDialplan":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":255,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"}},"example":{"id":12345,"account_id":1,"name":"Example Name"}},"devButton":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":11,"example":1},"company_id":{"description":"Company Id","type":"integer","maxLength":10,"minimum":0,"example":1},"app_id":{"description":"App Id","type":"string","maxLength":40,"example":1},"anvil_path":{"description":"Anvil Path","type":"string","maxLength":255,"example":"example_anvil_path"},"label":{"description":"Label","type":"string","maxLength":255,"example":"example_label"},"icon":{"description":"Icon","type":"string","maxLength":255,"example":"example_icon"},"tooltip":{"description":"Tooltip","type":"string","maxLength":500,"example":"example_tooltip"},"type":{"description":"Type","type":"string","maxLength":30,"example":"example_type"},"area":{"description":"Area","type":"string","maxLength":255,"default":"cp","example":"example_area"},"placement":{"description":"Placement","type":"string","maxLength":255,"example":"example_placement"},"min_select":{"description":"Min Select","type":"integer","maxLength":255,"minimum":0,"example":123},"max_select":{"description":"Max Select","type":"integer","maxLength":255,"minimum":0,"example":123},"sandbox_id":{"description":"Sandbox Id","type":"integer","maxLength":10,"minimum":0,"example":1},"fn":{"description":"Fn","type":"string","maxLength":255,"default":"main","example":"example_fn"},"form_id":{"description":"Form Id","type":"integer","maxLength":10,"minimum":0,"example":1},"page_id":{"description":"Page Id","type":"string","maxLength":40,"example":1},"sort_order":{"description":"Sort Order","type":"integer","maxLength":255,"minimum":0,"default":"50","example":1},"company_ids":{"description":"Company Ids","type":"string","maxLength":5000,"example":"example_company_ids"},"open_mode":{"description":"Open Mode","type":"string","enum":["page","dialog"],"example":"page"}},"example":{"id":12345,"account_id":1,"company_id":1,"app_id":1,"anvil_path":"example_anvil_path","label":"example_label","icon":"example_icon","tooltip":"example_tooltip","type":"example_type","area":"example_area","placement":"example_placement","min_select":123,"max_select":123,"sandbox_id":1,"fn":"example_fn","form_id":1,"page_id":1,"sort_order":1,"company_ids":"example_company_ids","open_mode":"page"}},"devButtonInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":11,"example":1},"company_id":{"description":"Company Id","type":"integer","maxLength":10,"minimum":0,"example":1},"app_id":{"description":"App Id","type":"string","maxLength":40,"example":1},"anvil_path":{"description":"Anvil Path","type":"string","maxLength":255,"example":"example_anvil_path"},"label":{"description":"Label","type":"string","maxLength":255,"example":"example_label"},"icon":{"description":"Icon","type":"string","maxLength":255,"example":"example_icon"},"tooltip":{"description":"Tooltip","type":"string","maxLength":500,"example":"example_tooltip"},"type":{"description":"Type","type":"string","maxLength":30,"example":"example_type"},"area":{"description":"Area","type":"string","maxLength":255,"default":"cp","example":"example_area"},"placement":{"description":"Placement","type":"string","maxLength":255,"example":"example_placement"},"min_select":{"description":"Min Select","type":"integer","maxLength":255,"minimum":0,"example":123},"max_select":{"description":"Max Select","type":"integer","maxLength":255,"minimum":0,"example":123},"sandbox_id":{"description":"Sandbox Id","type":"integer","maxLength":10,"minimum":0,"example":1},"fn":{"description":"Fn","type":"string","maxLength":255,"default":"main","example":"example_fn"},"form_id":{"description":"Form Id","type":"integer","maxLength":10,"minimum":0,"example":1},"page_id":{"description":"Page Id","type":"string","maxLength":40,"example":1},"sort_order":{"description":"Sort Order","type":"integer","maxLength":255,"minimum":0,"default":"50","example":1},"company_ids":{"description":"Company Ids","type":"string","maxLength":5000,"example":"example_company_ids"},"open_mode":{"description":"Open Mode","type":"string","enum":["page","dialog"],"example":"page"}},"example":{"id":12345,"account_id":1,"company_id":1,"app_id":1,"anvil_path":"example_anvil_path","label":"example_label","icon":"example_icon","tooltip":"example_tooltip","type":"example_type","area":"example_area","placement":"example_placement","min_select":123,"max_select":123,"sandbox_id":1,"fn":"example_fn","form_id":1,"page_id":1,"sort_order":1,"company_ids":"example_company_ids","open_mode":"page"}},"devDb":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"example":12345},"app_id":{"description":"App Id (references app.id)","type":"string","nullable":false,"maxLength":40,"x-foreignKey":{"referencesTable":"app","referencesColumn":"id"},"example":1},"type":{"description":"Type","type":"string","enum":["mysql"],"nullable":false,"default":"mysql","example":"mysql"},"host":{"description":"Host","type":"string","nullable":false,"maxLength":255,"example":"example_host"},"port":{"description":"Port","type":"string","nullable":false,"maxLength":255,"example":"example_port"},"username":{"description":"Username","type":"string","nullable":false,"maxLength":255,"example":"john_doe"},"password":{"description":"Password","type":"string","format":"password","nullable":false,"maxLength":255,"example":"********"}},"example":{"id":12345,"app_id":1,"type":"mysql","host":"example_host","port":"example_port","username":"john_doe","password":"********"}},"devDbInput":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"example":12345},"app_id":{"description":"App Id (references app.id)","type":"string","nullable":false,"maxLength":40,"x-foreignKey":{"referencesTable":"app","referencesColumn":"id"},"example":1},"type":{"description":"Type","type":"string","enum":["mysql"],"nullable":false,"default":"mysql","example":"mysql"},"host":{"description":"Host","type":"string","nullable":false,"maxLength":255,"example":"example_host"},"port":{"description":"Port","type":"string","nullable":false,"maxLength":255,"example":"example_port"},"username":{"description":"Username","type":"string","nullable":false,"maxLength":255,"example":"john_doe"},"password":{"description":"Password","type":"string","format":"password","nullable":false,"maxLength":255,"example":"********"}},"example":{"id":12345,"app_id":1,"type":"mysql","host":"example_host","port":"example_port","username":"john_doe","password":"********"},"required":["app_id","type","host","port","username","password"]},"project":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":40,"default":"uuid()","example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"description":{"description":"Description","type":"string","example":"A detailed description of the resource"},"icon":{"description":"Icon","type":"string","maxLength":255,"example":"example_icon"},"approved":{"description":"Approved","type":"integer","maxLength":4,"minimum":0,"example":1},"anvil_mcp_api_key":{"description":"Anvil Mcp Api Key","type":"string","maxLength":255,"example":"example_anvil_mcp_api_key"}},"example":{"id":12345,"account_id":1,"name":"Example Name","description":"A detailed description of the resource","icon":"example_icon","approved":1,"anvil_mcp_api_key":"example_anvil_mcp_api_key"}},"projectInput":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":40,"default":"uuid()","example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"description":{"description":"Description","type":"string","example":"A detailed description of the resource"},"icon":{"description":"Icon","type":"string","maxLength":255,"example":"example_icon"},"approved":{"description":"Approved","type":"integer","maxLength":4,"minimum":0,"example":1},"anvil_mcp_api_key":{"description":"Anvil Mcp Api Key","type":"string","maxLength":255,"example":"example_anvil_mcp_api_key"}},"example":{"id":12345,"account_id":1,"name":"Example Name","description":"A detailed description of the resource","icon":"example_icon","approved":1,"anvil_mcp_api_key":"example_anvil_mcp_api_key"},"required":["name"]},"alert":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"company_id":{"description":"Company Id (references company.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"company","referencesColumn":"id"},"example":1},"title":{"description":"Title","type":"string","maxLength":100,"example":"Example Name"},"area":{"description":"Area","type":"string","nullable":false,"maxLength":50,"example":"example_area"},"operator":{"description":"Operator","type":"string","enum":["<","<=","=",">",">=","always"],"example":"<"},"threshold":{"description":"Threshold","type":"number","maxLength":10,"example":99.99},"reset_threshold":{"description":"Reset Threshold","type":"number","maxLength":10,"example":99.99},"sample_period":{"description":"Sample Period","type":"integer","maxLength":10,"minimum":0,"example":123},"recipient":{"description":"Recipient","type":"string","maxLength":1000,"example":"example_recipient"},"template":{"description":"Template","type":"string","maxLength":100,"example":"example_template"},"state":{"description":"State","type":"string","enum":["Paused","Ready","Fired","Sent","Simulate"],"default":"Ready","example":"Paused"},"penalty":{"description":"Penalty","type":"integer","maxLength":10,"minimum":0,"example":123},"reset_timeout":{"description":"Reset Timeout","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"cron":{"description":"Cron","type":"string","maxLength":100,"example":"example_cron"},"sandbox_id":{"description":"Sandbox Id","type":"integer","maxLength":10,"minimum":0,"example":1},"last_ran":{"description":"Last Ran","type":"string","format":"date-time","nullable":true,"maxLength":6,"example":"2025-01-17T10:30:00Z"},"next_run":{"description":"Next Run","type":"string","format":"date-time","maxLength":6,"example":"2025-01-17T10:30:00Z"},"tag":{"description":"Tag","type":"string","maxLength":255,"example":"example_tag"},"notice_level":{"description":"Notice Level","type":"string","enum":["none","warning","error"],"nullable":false,"default":"none","example":"none"},"table_change":{"description":"Table Change","type":"string","maxLength":255,"example":"example_table_change"},"query":{"description":"Query","type":"string","example":"Sample query text content"}},"example":{"id":12345,"company_id":1,"title":"Example Name","area":"example_area","operator":"<","threshold":99.99,"reset_threshold":99.99,"sample_period":123,"recipient":"example_recipient","template":"example_template","state":"Paused","penalty":123,"reset_timeout":"2025-01-17T10:30:00Z","cron":"example_cron","sandbox_id":1,"last_ran":"2025-01-17T10:30:00Z","next_run":"2025-01-17T10:30:00Z","tag":"example_tag","notice_level":"none","table_change":"example_table_change","query":"Sample query text content"}},"alertInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"company_id":{"description":"Company Id (references company.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"company","referencesColumn":"id"},"example":1},"title":{"description":"Title","type":"string","maxLength":100,"example":"Example Name"},"area":{"description":"Area","type":"string","nullable":false,"maxLength":50,"example":"example_area"},"operator":{"description":"Operator","type":"string","enum":["<","<=","=",">",">=","always"],"example":"<"},"threshold":{"description":"Threshold","type":"number","maxLength":10,"example":99.99},"reset_threshold":{"description":"Reset Threshold","type":"number","maxLength":10,"example":99.99},"sample_period":{"description":"Sample Period","type":"integer","maxLength":10,"minimum":0,"example":123},"recipient":{"description":"Recipient","type":"string","maxLength":1000,"example":"example_recipient"},"template":{"description":"Template","type":"string","maxLength":100,"example":"example_template"},"state":{"description":"State","type":"string","enum":["Paused","Ready","Fired","Sent","Simulate"],"default":"Ready","example":"Paused"},"penalty":{"description":"Penalty","type":"integer","maxLength":10,"minimum":0,"example":123},"reset_timeout":{"description":"Reset Timeout","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"cron":{"description":"Cron","type":"string","maxLength":100,"example":"example_cron"},"sandbox_id":{"description":"Sandbox Id","type":"integer","maxLength":10,"minimum":0,"example":1},"last_ran":{"description":"Last Ran","type":"string","format":"date-time","nullable":true,"maxLength":6,"example":"2025-01-17T10:30:00Z"},"next_run":{"description":"Next Run","type":"string","format":"date-time","maxLength":6,"example":"2025-01-17T10:30:00Z"},"tag":{"description":"Tag","type":"string","maxLength":255,"example":"example_tag"},"notice_level":{"description":"Notice Level","type":"string","enum":["none","warning","error"],"nullable":false,"default":"none","example":"none"},"table_change":{"description":"Table Change","type":"string","maxLength":255,"example":"example_table_change"},"query":{"description":"Query","type":"string","example":"Sample query text content"}},"example":{"id":12345,"company_id":1,"title":"Example Name","area":"example_area","operator":"<","threshold":99.99,"reset_threshold":99.99,"sample_period":123,"recipient":"example_recipient","template":"example_template","state":"Paused","penalty":123,"reset_timeout":"2025-01-17T10:30:00Z","cron":"example_cron","sandbox_id":1,"last_ran":"2025-01-17T10:30:00Z","next_run":"2025-01-17T10:30:00Z","tag":"example_tag","notice_level":"none","table_change":"example_table_change","query":"Sample query text content"},"required":["company_id","area","notice_level"]},"alias":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"company_id":{"description":"Company Id (references company.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"company","referencesColumn":"id"},"example":1},"current":{"description":"Current","type":"string","nullable":false,"maxLength":255,"example":"example_current"},"new":{"description":"New","type":"string","nullable":false,"maxLength":255,"example":"example_new"}},"example":{"id":12345,"company_id":1,"current":"example_current","new":"example_new"}},"aliasInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"company_id":{"description":"Company Id (references company.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"company","referencesColumn":"id"},"example":1},"current":{"description":"Current","type":"string","nullable":false,"maxLength":255,"example":"example_current"},"new":{"description":"New","type":"string","nullable":false,"maxLength":255,"example":"example_new"}},"example":{"id":12345,"company_id":1,"current":"example_current","new":"example_new"},"required":["current","new"]},"cardRevision":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"card_id":{"description":"Card Id (references card.id)","type":"string","nullable":false,"maxLength":10,"x-foreignKey":{"referencesTable":"card","referencesColumn":"id"},"example":1},"name":{"description":"Name","type":"string","nullable":false,"maxLength":50,"example":"Example Name"},"ts":{"description":"Ts","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"revision":{"description":"Revision","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":123},"presentation":{"description":"Presentation","type":"string","maxLength":255,"example":"example_presentation"},"external":{"description":"External","type":"integer","nullable":false,"maxLength":1,"minimum":0,"default":"0","example":1},"expire":{"description":"Expire","type":"string","format":"date-time","nullable":false,"example":"2025-01-17T10:30:00Z"},"stale":{"description":"Stale","type":"integer","nullable":false,"maxLength":4,"minimum":0,"default":"0","example":1},"currency":{"description":"Currency","type":"string","maxLength":4,"example":"USD"},"date_live":{"description":"Date Live","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"count":{"description":"Count","type":"integer","maxLength":9,"minimum":0,"example":10},"live_rev_id":{"description":"Live Rev Id","type":"integer","maxLength":10,"minimum":0,"example":1},"billing_precision":{"description":"Billing Precision","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"4","example":1},"rounding_method":{"description":"Rounding Method","type":"string","enum":["up","down","half-up","half-down"],"default":"half-up","example":"up"},"duration_rounding_method":{"description":"Duration Rounding Method","type":"string","enum":["up","down","half-up","half-down"],"default":"half-up","example":"up"},"origin_billing_source":{"description":"Origin Billing Source","type":"string","nullable":false,"maxLength":255,"example":"example_origin_billing_source"},"origin_billing_destination":{"description":"Origin Billing Destination","type":"string","nullable":false,"maxLength":255,"example":"example_origin_billing_destination"},"storage":{"description":"Storage","type":"string","enum":["live","archive","archiving","archiving-deleting","making-live"],"nullable":false,"default":"live","example":"live"},"archiving_at":{"description":"Archiving At","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"archive_rule_count":{"description":"Archive Rule Count","type":"integer","maxLength":20,"minimum":0,"example":10},"archive_sha256":{"description":"Archive Sha 256","type":"string","maxLength":64,"example":"example_archive_sha256"},"archive_size":{"description":"Archive Size","type":"integer","maxLength":20,"minimum":0,"example":1000000},"archive_created_at":{"description":"Archive Created At","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"archive_deleted_at":{"description":"Archive Deleted At","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"archive_error":{"description":"Archive Error","type":"string","example":"Sample archive_error text content"}},"example":{"id":12345,"card_id":1,"name":"Example Name","ts":"2025-01-17T10:30:00Z","revision":123,"presentation":"example_presentation","external":1,"expire":"2025-01-17T10:30:00Z","stale":1,"currency":"USD","date_live":"2025-01-17T10:30:00Z","count":10,"live_rev_id":1,"billing_precision":1,"rounding_method":"up","duration_rounding_method":"up","origin_billing_source":"example_origin_billing_source","origin_billing_destination":"example_origin_billing_destination","storage":"live","archiving_at":"2025-01-17T10:30:00Z","archive_rule_count":10,"archive_sha256":"example_archive_sha256","archive_size":1000000,"archive_created_at":"2025-01-17T10:30:00Z","archive_deleted_at":"2025-01-17T10:30:00Z","archive_error":"Sample archive_error text content"}},"cardRevisionInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"card_id":{"description":"Card Id (references card.id)","type":"string","nullable":false,"maxLength":10,"x-foreignKey":{"referencesTable":"card","referencesColumn":"id"},"example":1},"name":{"description":"Name","type":"string","nullable":false,"maxLength":50,"example":"Example Name"},"ts":{"description":"Ts","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"revision":{"description":"Revision","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":123},"presentation":{"description":"Presentation","type":"string","maxLength":255,"example":"example_presentation"},"external":{"description":"External","type":"integer","nullable":false,"maxLength":1,"minimum":0,"default":"0","example":1},"expire":{"description":"Expire","type":"string","format":"date-time","nullable":false,"example":"2025-01-17T10:30:00Z"},"stale":{"description":"Stale","type":"integer","nullable":false,"maxLength":4,"minimum":0,"default":"0","example":1},"currency":{"description":"Currency","type":"string","maxLength":4,"example":"USD"},"date_live":{"description":"Date Live","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"count":{"description":"Count","type":"integer","maxLength":9,"minimum":0,"example":10},"live_rev_id":{"description":"Live Rev Id","type":"integer","maxLength":10,"minimum":0,"example":1},"billing_precision":{"description":"Billing Precision","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"4","example":1},"rounding_method":{"description":"Rounding Method","type":"string","enum":["up","down","half-up","half-down"],"default":"half-up","example":"up"},"duration_rounding_method":{"description":"Duration Rounding Method","type":"string","enum":["up","down","half-up","half-down"],"default":"half-up","example":"up"},"origin_billing_source":{"description":"Origin Billing Source","type":"string","nullable":false,"maxLength":255,"example":"example_origin_billing_source"},"origin_billing_destination":{"description":"Origin Billing Destination","type":"string","nullable":false,"maxLength":255,"example":"example_origin_billing_destination"},"storage":{"description":"Storage","type":"string","enum":["live","archive","archiving","archiving-deleting","making-live"],"nullable":false,"default":"live","example":"live"},"archiving_at":{"description":"Archiving At","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"archive_rule_count":{"description":"Archive Rule Count","type":"integer","maxLength":20,"minimum":0,"example":10},"archive_sha256":{"description":"Archive Sha 256","type":"string","maxLength":64,"example":"example_archive_sha256"},"archive_size":{"description":"Archive Size","type":"integer","maxLength":20,"minimum":0,"example":1000000},"archive_created_at":{"description":"Archive Created At","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"archive_deleted_at":{"description":"Archive Deleted At","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"archive_error":{"description":"Archive Error","type":"string","example":"Sample archive_error text content"}},"example":{"id":12345,"card_id":1,"name":"Example Name","ts":"2025-01-17T10:30:00Z","revision":123,"presentation":"example_presentation","external":1,"expire":"2025-01-17T10:30:00Z","stale":1,"currency":"USD","date_live":"2025-01-17T10:30:00Z","count":10,"live_rev_id":1,"billing_precision":1,"rounding_method":"up","duration_rounding_method":"up","origin_billing_source":"example_origin_billing_source","origin_billing_destination":"example_origin_billing_destination","storage":"live","archiving_at":"2025-01-17T10:30:00Z","archive_rule_count":10,"archive_sha256":"example_archive_sha256","archive_size":1000000,"archive_created_at":"2025-01-17T10:30:00Z","archive_deleted_at":"2025-01-17T10:30:00Z","archive_error":"Sample archive_error text content"},"required":["card_id","name","ts","revision","external","expire","stale","billing_precision","origin_billing_source","origin_billing_destination","storage"]},"cli":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"company_id":{"description":"Company Id (references company.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"company","referencesColumn":"id"},"example":1},"cli":{"description":"Cli","type":"string","maxLength":500,"example":"example_cli"},"cli_rewrite":{"description":"Cli Rewrite","type":"string","maxLength":50,"example":"example_cli_rewrite"},"p_asserted_identity_rewrite":{"description":"P Asserted Identity Rewrite","type":"string","maxLength":50,"example":"example_p_asserted_identity_rewrite"},"forced":{"description":"Forced","type":"integer","maxLength":3,"minimum":0,"default":"0","example":1},"p_asserted_identity":{"description":"P Asserted Identity","type":"string","maxLength":50,"example":"example_p_asserted_identity"},"notes":{"description":"Notes","type":"string","maxLength":1000,"example":"example_notes"},"origination":{"description":"Origination","type":"integer","maxLength":1,"minimum":0,"default":"0","example":1},"use_did":{"description":"Use Did","type":"string","enum":["Disabled","Filter","Random","Prefix Match","Performance"],"nullable":false,"default":"Disabled","example":"Disabled"},"stir_shaken_cert_id":{"description":"Stir Shaken Cert Id","type":"string","maxLength":32,"example":1},"stir_shaken_attestation":{"description":"Stir Shaken Attestation","type":"string","enum":["None","A","B","C"],"nullable":false,"default":"None","example":"None"},"dn_match":{"description":"Dn Match","type":"string","maxLength":500,"example":"example_dn_match"},"datastore_id":{"description":"Datastore Id","type":"string","maxLength":100,"example":1},"allow_type":{"description":"Allow Type","type":"string","maxLength":255,"example":"example_allow_type"},"ftc_reported":{"description":"Ftc Reported","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"flags":{"description":"Flags","type":"string","maxLength":255,"example":"example_flags"},"performance_top_batch_size":{"description":"Performance Top Batch Size","type":"integer","maxLength":5,"minimum":0,"example":100},"performance_interval":{"description":"Performance Interval","type":"integer","maxLength":8,"minimum":0,"example":1000},"performance_ban_time":{"description":"Performance Ban Time","type":"integer","maxLength":8,"minimum":0,"example":1000},"hit_limit":{"description":"Hit Limit","type":"integer","maxLength":10,"minimum":0,"example":123},"hit_interval":{"description":"Hit Interval","type":"integer","maxLength":10,"minimum":0,"example":1000},"idx":{"description":"Idx","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1}},"example":{"id":12345,"company_id":1,"cli":"example_cli","cli_rewrite":"example_cli_rewrite","p_asserted_identity_rewrite":"example_p_asserted_identity_rewrite","forced":1,"p_asserted_identity":"example_p_asserted_identity","notes":"example_notes","origination":1,"use_did":"Disabled","stir_shaken_cert_id":1,"stir_shaken_attestation":"None","dn_match":"example_dn_match","datastore_id":1,"allow_type":"example_allow_type","ftc_reported":1,"flags":"example_flags","performance_top_batch_size":100,"performance_interval":1000,"performance_ban_time":1000,"hit_limit":123,"hit_interval":1000,"idx":1}},"cliInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"company_id":{"description":"Company Id (references company.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"company","referencesColumn":"id"},"example":1},"cli":{"description":"Cli","type":"string","maxLength":500,"example":"example_cli"},"cli_rewrite":{"description":"Cli Rewrite","type":"string","maxLength":50,"example":"example_cli_rewrite"},"p_asserted_identity_rewrite":{"description":"P Asserted Identity Rewrite","type":"string","maxLength":50,"example":"example_p_asserted_identity_rewrite"},"forced":{"description":"Forced","type":"integer","maxLength":3,"minimum":0,"default":"0","example":1},"p_asserted_identity":{"description":"P Asserted Identity","type":"string","maxLength":50,"example":"example_p_asserted_identity"},"notes":{"description":"Notes","type":"string","maxLength":1000,"example":"example_notes"},"origination":{"description":"Origination","type":"integer","maxLength":1,"minimum":0,"default":"0","example":1},"use_did":{"description":"Use Did","type":"string","enum":["Disabled","Filter","Random","Prefix Match","Performance"],"nullable":false,"default":"Disabled","example":"Disabled"},"stir_shaken_cert_id":{"description":"Stir Shaken Cert Id","type":"string","maxLength":32,"example":1},"stir_shaken_attestation":{"description":"Stir Shaken Attestation","type":"string","enum":["None","A","B","C"],"nullable":false,"default":"None","example":"None"},"dn_match":{"description":"Dn Match","type":"string","maxLength":500,"example":"example_dn_match"},"datastore_id":{"description":"Datastore Id","type":"string","maxLength":100,"example":1},"allow_type":{"description":"Allow Type","type":"string","maxLength":255,"example":"example_allow_type"},"ftc_reported":{"description":"Ftc Reported","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"flags":{"description":"Flags","type":"string","maxLength":255,"example":"example_flags"},"performance_top_batch_size":{"description":"Performance Top Batch Size","type":"integer","maxLength":5,"minimum":0,"example":100},"performance_interval":{"description":"Performance Interval","type":"integer","maxLength":8,"minimum":0,"example":1000},"performance_ban_time":{"description":"Performance Ban Time","type":"integer","maxLength":8,"minimum":0,"example":1000},"hit_limit":{"description":"Hit Limit","type":"integer","maxLength":10,"minimum":0,"example":123},"hit_interval":{"description":"Hit Interval","type":"integer","maxLength":10,"minimum":0,"example":1000},"idx":{"description":"Idx","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1}},"example":{"id":12345,"company_id":1,"cli":"example_cli","cli_rewrite":"example_cli_rewrite","p_asserted_identity_rewrite":"example_p_asserted_identity_rewrite","forced":1,"p_asserted_identity":"example_p_asserted_identity","notes":"example_notes","origination":1,"use_did":"Disabled","stir_shaken_cert_id":1,"stir_shaken_attestation":"None","dn_match":"example_dn_match","datastore_id":1,"allow_type":"example_allow_type","ftc_reported":1,"flags":"example_flags","performance_top_batch_size":100,"performance_interval":1000,"performance_ban_time":1000,"hit_limit":123,"hit_interval":1000,"idx":1},"required":["use_did","stir_shaken_attestation","ftc_reported","idx"]},"contact":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"company_id":{"description":"Company Id (references company.id)","type":"integer","nullable":false,"maxLength":11,"minimum":0,"x-foreignKey":{"referencesTable":"company","referencesColumn":"id"},"example":1},"name":{"description":"Name","type":"string","maxLength":50,"example":"Example Name"},"email":{"description":"Email","type":"string","format":"email","nullable":false,"maxLength":254,"example":"user@example.com"},"contact_type":{"description":"Contact Type","type":"string","enum":["General","Sales","Accounts","NOC","Rates"],"nullable":false,"default":"General","example":"General"},"phone":{"description":"Phone","type":"string","maxLength":20,"example":"+1-555-123-4567"},"mobile":{"description":"Mobile","type":"string","maxLength":20,"example":"+1-555-123-4567"},"skype":{"description":"Skype","type":"string","maxLength":30,"example":"example_skype"},"public_notes":{"description":"Public Notes","type":"string","example":"Sample public_notes text content"},"private_notes":{"description":"Private Notes","type":"string","example":"Sample private_notes text content"},"logins":{"description":"Logins","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":123},"last_login":{"description":"Last Login","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"portal_area":{"description":"Portal Area","type":"string","maxLength":500,"example":"example_portal_area"},"mobile_verify":{"description":"Mobile Verify","type":"integer","maxLength":1,"minimum":0,"default":"0","example":1},"email_verify":{"description":"Email Verify","type":"integer","maxLength":1,"minimum":0,"default":"0","example":1},"ip_whitelist":{"description":"Ip Whitelist","type":"string","maxLength":255,"example":"example_ip_whitelist"}},"example":{"id":12345,"company_id":1,"name":"Example Name","email":"user@example.com","contact_type":"General","phone":"+1-555-123-4567","mobile":"+1-555-123-4567","skype":"example_skype","public_notes":"Sample public_notes text content","private_notes":"Sample private_notes text content","logins":123,"last_login":"2025-01-17T10:30:00Z","portal_area":"example_portal_area","mobile_verify":1,"email_verify":1,"ip_whitelist":"example_ip_whitelist"}},"contactInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"company_id":{"description":"Company Id (references company.id)","type":"integer","nullable":false,"maxLength":11,"minimum":0,"x-foreignKey":{"referencesTable":"company","referencesColumn":"id"},"example":1},"name":{"description":"Name","type":"string","maxLength":50,"example":"Example Name"},"email":{"description":"Email","type":"string","format":"email","nullable":false,"maxLength":254,"example":"user@example.com"},"contact_type":{"description":"Contact Type","type":"string","enum":["General","Sales","Accounts","NOC","Rates"],"nullable":false,"default":"General","example":"General"},"phone":{"description":"Phone","type":"string","maxLength":20,"example":"+1-555-123-4567"},"mobile":{"description":"Mobile","type":"string","maxLength":20,"example":"+1-555-123-4567"},"skype":{"description":"Skype","type":"string","maxLength":30,"example":"example_skype"},"public_notes":{"description":"Public Notes","type":"string","example":"Sample public_notes text content"},"private_notes":{"description":"Private Notes","type":"string","example":"Sample private_notes text content"},"logins":{"description":"Logins","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":123},"last_login":{"description":"Last Login","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"portal_area":{"description":"Portal Area","type":"string","maxLength":500,"example":"example_portal_area"},"mobile_verify":{"description":"Mobile Verify","type":"integer","maxLength":1,"minimum":0,"default":"0","example":1},"email_verify":{"description":"Email Verify","type":"integer","maxLength":1,"minimum":0,"default":"0","example":1},"ip_whitelist":{"description":"Ip Whitelist","type":"string","maxLength":255,"example":"example_ip_whitelist"}},"example":{"id":12345,"company_id":1,"name":"Example Name","email":"user@example.com","contact_type":"General","phone":"+1-555-123-4567","mobile":"+1-555-123-4567","skype":"example_skype","public_notes":"Sample public_notes text content","private_notes":"Sample private_notes text content","logins":123,"last_login":"2025-01-17T10:30:00Z","portal_area":"example_portal_area","mobile_verify":1,"email_verify":1,"ip_whitelist":"example_ip_whitelist"},"required":["company_id","name","email","contact_type","logins"]},"contract":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"contract_rev_id":{"description":"Contract Rev Id (references contract_rev.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"contract_rev","referencesColumn":"id"},"example":1},"company_id":{"description":"Company Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":1},"route_ingress_id":{"description":"Route Ingress Id","type":"integer","maxLength":10,"minimum":0,"example":1},"required":{"description":"Required","type":"integer","maxLength":3,"minimum":0,"default":"0","example":1},"date_created":{"description":"Date Created","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"date_grace":{"description":"Date Grace","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"date_approved":{"description":"Date Approved","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"approved_by":{"description":"Approved By","type":"string","maxLength":255,"example":"example_approved_by"},"identity_id":{"description":"Identity Id","type":"string","maxLength":255,"example":1}},"example":{"id":12345,"contract_rev_id":1,"company_id":1,"route_ingress_id":1,"required":1,"date_created":"2025-01-17T10:30:00Z","date_grace":"2025-01-17T10:30:00Z","date_approved":"2025-01-17T10:30:00Z","approved_by":"example_approved_by","identity_id":1}},"contractInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"contract_rev_id":{"description":"Contract Rev Id (references contract_rev.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"contract_rev","referencesColumn":"id"},"example":1},"company_id":{"description":"Company Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":1},"route_ingress_id":{"description":"Route Ingress Id","type":"integer","maxLength":10,"minimum":0,"example":1},"required":{"description":"Required","type":"integer","maxLength":3,"minimum":0,"default":"0","example":1},"date_created":{"description":"Date Created","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"date_grace":{"description":"Date Grace","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"date_approved":{"description":"Date Approved","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"approved_by":{"description":"Approved By","type":"string","maxLength":255,"example":"example_approved_by"},"identity_id":{"description":"Identity Id","type":"string","maxLength":255,"example":1}},"example":{"id":12345,"contract_rev_id":1,"company_id":1,"route_ingress_id":1,"required":1,"date_created":"2025-01-17T10:30:00Z","date_grace":"2025-01-17T10:30:00Z","date_approved":"2025-01-17T10:30:00Z","approved_by":"example_approved_by","identity_id":1},"required":["contract_rev_id","company_id"]},"document":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"company_id":{"description":"Company Id","type":"integer","maxLength":10,"minimum":0,"example":1},"dt":{"description":"Dt","type":"string","format":"date-time","maxLength":6,"example":"2025-01-17T10:30:00Z"},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"notes":{"description":"Notes","type":"string","example":"Sample notes text content"},"customer_notes":{"description":"Customer Notes","type":"string","example":"Sample customer_notes text content"},"filename":{"description":"Filename","type":"string","maxLength":255,"example":"example_filename"}},"example":{"id":12345,"company_id":1,"dt":"2025-01-17T10:30:00Z","name":"Example Name","notes":"Sample notes text content","customer_notes":"Sample customer_notes text content","filename":"example_filename"}},"documentInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"company_id":{"description":"Company Id","type":"integer","maxLength":10,"minimum":0,"example":1},"dt":{"description":"Dt","type":"string","format":"date-time","maxLength":6,"example":"2025-01-17T10:30:00Z"},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"notes":{"description":"Notes","type":"string","example":"Sample notes text content"},"customer_notes":{"description":"Customer Notes","type":"string","example":"Sample customer_notes text content"},"filename":{"description":"Filename","type":"string","maxLength":255,"example":"example_filename"}},"example":{"id":12345,"company_id":1,"dt":"2025-01-17T10:30:00Z","name":"Example Name","notes":"Sample notes text content","customer_notes":"Sample customer_notes text content","filename":"example_filename"},"required":["name"]},"invoiceLine":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"invoice_id":{"description":"Invoice Id (references invoice.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"invoice","referencesColumn":"id"},"example":1},"qty":{"description":"Qty","type":"integer","maxLength":11,"example":123},"package_id":{"description":"Package Id","type":"integer","maxLength":10,"minimum":0,"example":1},"description":{"description":"Description","type":"string","maxLength":10000,"example":"A detailed description of the resource"},"start_date":{"description":"Start Date","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"end_date":{"description":"End Date","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"unit_price":{"description":"Unit Price","type":"number","maxLength":20,"example":99.99},"net":{"description":"Net","type":"number","maxLength":20,"example":99.99},"tax":{"description":"Tax","type":"number","nullable":false,"maxLength":20,"example":99.99},"sub_total":{"description":"Sub Total","type":"number","maxLength":20,"example":10},"attempts":{"description":"Attempts","type":"integer","maxLength":255,"minimum":0,"example":123},"connected":{"description":"Connected","type":"integer","maxLength":255,"minimum":0,"example":123},"duration":{"description":"Duration","type":"integer","maxLength":255,"minimum":0,"example":123},"json":{"description":"Json","type":"string","example":"Sample json text content"}},"example":{"id":12345,"invoice_id":1,"qty":123,"package_id":1,"description":"A detailed description of the resource","start_date":"2025-01-17T10:30:00Z","end_date":"2025-01-17T10:30:00Z","unit_price":99.99,"net":99.99,"tax":99.99,"sub_total":10,"attempts":123,"connected":123,"duration":123,"json":"Sample json text content"}},"invoiceLineInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"invoice_id":{"description":"Invoice Id (references invoice.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"invoice","referencesColumn":"id"},"example":1},"qty":{"description":"Qty","type":"integer","maxLength":11,"example":123},"package_id":{"description":"Package Id","type":"integer","maxLength":10,"minimum":0,"example":1},"description":{"description":"Description","type":"string","maxLength":10000,"example":"A detailed description of the resource"},"start_date":{"description":"Start Date","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"end_date":{"description":"End Date","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"unit_price":{"description":"Unit Price","type":"number","maxLength":20,"example":99.99},"net":{"description":"Net","type":"number","maxLength":20,"example":99.99},"tax":{"description":"Tax","type":"number","nullable":false,"maxLength":20,"example":99.99},"sub_total":{"description":"Sub Total","type":"number","maxLength":20,"example":10},"attempts":{"description":"Attempts","type":"integer","maxLength":255,"minimum":0,"example":123},"connected":{"description":"Connected","type":"integer","maxLength":255,"minimum":0,"example":123},"duration":{"description":"Duration","type":"integer","maxLength":255,"minimum":0,"example":123},"json":{"description":"Json","type":"string","example":"Sample json text content"}},"example":{"id":12345,"invoice_id":1,"qty":123,"package_id":1,"description":"A detailed description of the resource","start_date":"2025-01-17T10:30:00Z","end_date":"2025-01-17T10:30:00Z","unit_price":99.99,"net":99.99,"tax":99.99,"sub_total":10,"attempts":123,"connected":123,"duration":123,"json":"Sample json text content"},"required":["invoice_id","tax"]},"invoicePayment":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"invoice_id":{"description":"Invoice Id (references invoice.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"invoice","referencesColumn":"id"},"example":1},"payment_id":{"description":"Payment Id (references payment.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"payment","referencesColumn":"id"},"example":1},"total":{"description":"Total","type":"number","maxLength":8,"example":10}},"example":{"id":12345,"invoice_id":1,"payment_id":1,"total":10}},"invoicePaymentInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"invoice_id":{"description":"Invoice Id (references invoice.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"invoice","referencesColumn":"id"},"example":1},"payment_id":{"description":"Payment Id (references payment.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"payment","referencesColumn":"id"},"example":1},"total":{"description":"Total","type":"number","maxLength":8,"example":10}},"example":{"id":12345,"invoice_id":1,"payment_id":1,"total":10}},"payment":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"company_id":{"description":"Company Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":1},"payment_time":{"description":"Payment Time","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"description":{"description":"Description","type":"string","maxLength":500,"example":"A detailed description of the resource"},"total":{"description":"Total","type":"number","nullable":false,"maxLength":14,"example":10},"tax_rate":{"description":"Tax Rate","type":"number","maxLength":5,"example":99.99},"invoice_id":{"description":"Invoice Id","type":"integer","maxLength":20,"example":1},"currency":{"description":"Currency","type":"string","maxLength":3,"example":"USD"},"override_xe":{"description":"Override Xe","type":"number","example":1.5},"payment_fee":{"description":"Payment Fee","type":"number","maxLength":10,"example":99.99},"status":{"description":"Status","type":"string","enum":["Completed","Pending","Canceled"],"default":"Completed","example":"Completed"},"payment_id":{"description":"Payment Id","type":"string","maxLength":200,"example":1},"charge_id":{"description":"Charge Id","type":"string","maxLength":200,"example":1},"reconciliation_id":{"description":"Reconciliation Id","type":"string","maxLength":200,"example":1},"tax_paid":{"description":"Tax Paid","type":"number","maxLength":8,"example":99.99}},"example":{"id":12345,"company_id":1,"payment_time":"2025-01-17T10:30:00Z","description":"A detailed description of the resource","total":10,"tax_rate":99.99,"invoice_id":1,"currency":"USD","override_xe":1.5,"payment_fee":99.99,"status":"Completed","payment_id":1,"charge_id":1,"reconciliation_id":1,"tax_paid":99.99}},"paymentInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"company_id":{"description":"Company Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":1},"payment_time":{"description":"Payment Time","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"description":{"description":"Description","type":"string","maxLength":500,"example":"A detailed description of the resource"},"total":{"description":"Total","type":"number","nullable":false,"maxLength":14,"example":10},"tax_rate":{"description":"Tax Rate","type":"number","maxLength":5,"example":99.99},"invoice_id":{"description":"Invoice Id","type":"integer","maxLength":20,"example":1},"currency":{"description":"Currency","type":"string","maxLength":3,"example":"USD"},"override_xe":{"description":"Override Xe","type":"number","example":1.5},"payment_fee":{"description":"Payment Fee","type":"number","maxLength":10,"example":99.99},"status":{"description":"Status","type":"string","enum":["Completed","Pending","Canceled"],"default":"Completed","example":"Completed"},"payment_id":{"description":"Payment Id","type":"string","maxLength":200,"example":1},"charge_id":{"description":"Charge Id","type":"string","maxLength":200,"example":1},"reconciliation_id":{"description":"Reconciliation Id","type":"string","maxLength":200,"example":1},"tax_paid":{"description":"Tax Paid","type":"number","maxLength":8,"example":99.99}},"example":{"id":12345,"company_id":1,"payment_time":"2025-01-17T10:30:00Z","description":"A detailed description of the resource","total":10,"tax_rate":99.99,"invoice_id":1,"currency":"USD","override_xe":1.5,"payment_fee":99.99,"status":"Completed","payment_id":1,"charge_id":1,"reconciliation_id":1,"tax_paid":99.99},"required":["company_id","payment_time","total"]},"phonebook":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"company_id":{"description":"Company Id","type":"integer","maxLength":11,"minimum":0,"example":1},"username":{"description":"Username","type":"string","maxLength":255,"example":"john_doe"},"organization":{"description":"Organization","type":"string","maxLength":255,"example":"example_organization"},"name_given":{"description":"Name Given","type":"string","maxLength":255,"example":"example_name_given"},"name_family":{"description":"Name Family","type":"string","maxLength":255,"example":"example_name_family"},"type":{"description":"Type","type":"string","maxLength":255,"example":"example_type"},"category":{"description":"Category","type":"string","maxLength":255,"example":"example_category"}},"example":{"id":12345,"company_id":1,"username":"john_doe","organization":"example_organization","name_given":"example_name_given","name_family":"example_name_family","type":"example_type","category":"example_category"}},"phonebookInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"company_id":{"description":"Company Id","type":"integer","maxLength":11,"minimum":0,"example":1},"username":{"description":"Username","type":"string","maxLength":255,"example":"john_doe"},"organization":{"description":"Organization","type":"string","maxLength":255,"example":"example_organization"},"name_given":{"description":"Name Given","type":"string","maxLength":255,"example":"example_name_given"},"name_family":{"description":"Name Family","type":"string","maxLength":255,"example":"example_name_family"},"type":{"description":"Type","type":"string","maxLength":255,"example":"example_type"},"category":{"description":"Category","type":"string","maxLength":255,"example":"example_category"}},"example":{"id":12345,"company_id":1,"username":"john_doe","organization":"example_organization","name_given":"example_name_given","name_family":"example_name_family","type":"example_type","category":"example_category"}},"rev":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"card_id":{"description":"Card Id (references card.id)","type":"string","nullable":false,"maxLength":10,"x-foreignKey":{"referencesTable":"card","referencesColumn":"id"},"example":1},"name":{"description":"Name","type":"string","nullable":false,"maxLength":50,"example":"Example Name"},"ts":{"description":"Ts","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"revision":{"description":"Revision","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":123},"presentation":{"description":"Presentation","type":"string","maxLength":255,"example":"example_presentation"},"external":{"description":"External","type":"integer","nullable":false,"maxLength":1,"minimum":0,"default":"0","example":1},"expire":{"description":"Expire","type":"string","format":"date-time","nullable":false,"example":"2025-01-17T10:30:00Z"},"stale":{"description":"Stale","type":"integer","nullable":false,"maxLength":4,"minimum":0,"default":"0","example":1},"currency":{"description":"Currency","type":"string","maxLength":4,"example":"USD"},"date_live":{"description":"Date Live","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"count":{"description":"Count","type":"integer","maxLength":9,"minimum":0,"example":10},"live_rev_id":{"description":"Live Rev Id","type":"integer","maxLength":10,"minimum":0,"example":1},"billing_precision":{"description":"Billing Precision","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"4","example":1},"rounding_method":{"description":"Rounding Method","type":"string","enum":["up","down","half-up","half-down"],"default":"half-up","example":"up"},"duration_rounding_method":{"description":"Duration Rounding Method","type":"string","enum":["up","down","half-up","half-down"],"default":"half-up","example":"up"},"origin_billing_source":{"description":"Origin Billing Source","type":"string","nullable":false,"maxLength":255,"example":"example_origin_billing_source"},"origin_billing_destination":{"description":"Origin Billing Destination","type":"string","nullable":false,"maxLength":255,"example":"example_origin_billing_destination"},"storage":{"description":"Storage","type":"string","enum":["live","archive","archiving","archiving-deleting","making-live"],"nullable":false,"default":"live","example":"live"},"archiving_at":{"description":"Archiving At","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"archive_rule_count":{"description":"Archive Rule Count","type":"integer","maxLength":20,"minimum":0,"example":10},"archive_sha256":{"description":"Archive Sha 256","type":"string","maxLength":64,"example":"example_archive_sha256"},"archive_size":{"description":"Archive Size","type":"integer","maxLength":20,"minimum":0,"example":1000000},"archive_created_at":{"description":"Archive Created At","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"archive_deleted_at":{"description":"Archive Deleted At","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"archive_error":{"description":"Archive Error","type":"string","example":"Sample archive_error text content"}},"example":{"id":12345,"card_id":1,"name":"Example Name","ts":"2025-01-17T10:30:00Z","revision":123,"presentation":"example_presentation","external":1,"expire":"2025-01-17T10:30:00Z","stale":1,"currency":"USD","date_live":"2025-01-17T10:30:00Z","count":10,"live_rev_id":1,"billing_precision":1,"rounding_method":"up","duration_rounding_method":"up","origin_billing_source":"example_origin_billing_source","origin_billing_destination":"example_origin_billing_destination","storage":"live","archiving_at":"2025-01-17T10:30:00Z","archive_rule_count":10,"archive_sha256":"example_archive_sha256","archive_size":1000000,"archive_created_at":"2025-01-17T10:30:00Z","archive_deleted_at":"2025-01-17T10:30:00Z","archive_error":"Sample archive_error text content"}},"revInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"card_id":{"description":"Card Id (references card.id)","type":"string","nullable":false,"maxLength":10,"x-foreignKey":{"referencesTable":"card","referencesColumn":"id"},"example":1},"name":{"description":"Name","type":"string","nullable":false,"maxLength":50,"example":"Example Name"},"ts":{"description":"Ts","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"revision":{"description":"Revision","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":123},"presentation":{"description":"Presentation","type":"string","maxLength":255,"example":"example_presentation"},"external":{"description":"External","type":"integer","nullable":false,"maxLength":1,"minimum":0,"default":"0","example":1},"expire":{"description":"Expire","type":"string","format":"date-time","nullable":false,"example":"2025-01-17T10:30:00Z"},"stale":{"description":"Stale","type":"integer","nullable":false,"maxLength":4,"minimum":0,"default":"0","example":1},"currency":{"description":"Currency","type":"string","maxLength":4,"example":"USD"},"date_live":{"description":"Date Live","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"count":{"description":"Count","type":"integer","maxLength":9,"minimum":0,"example":10},"live_rev_id":{"description":"Live Rev Id","type":"integer","maxLength":10,"minimum":0,"example":1},"billing_precision":{"description":"Billing Precision","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"4","example":1},"rounding_method":{"description":"Rounding Method","type":"string","enum":["up","down","half-up","half-down"],"default":"half-up","example":"up"},"duration_rounding_method":{"description":"Duration Rounding Method","type":"string","enum":["up","down","half-up","half-down"],"default":"half-up","example":"up"},"origin_billing_source":{"description":"Origin Billing Source","type":"string","nullable":false,"maxLength":255,"example":"example_origin_billing_source"},"origin_billing_destination":{"description":"Origin Billing Destination","type":"string","nullable":false,"maxLength":255,"example":"example_origin_billing_destination"},"storage":{"description":"Storage","type":"string","enum":["live","archive","archiving","archiving-deleting","making-live"],"nullable":false,"default":"live","example":"live"},"archiving_at":{"description":"Archiving At","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"archive_rule_count":{"description":"Archive Rule Count","type":"integer","maxLength":20,"minimum":0,"example":10},"archive_sha256":{"description":"Archive Sha 256","type":"string","maxLength":64,"example":"example_archive_sha256"},"archive_size":{"description":"Archive Size","type":"integer","maxLength":20,"minimum":0,"example":1000000},"archive_created_at":{"description":"Archive Created At","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"archive_deleted_at":{"description":"Archive Deleted At","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"archive_error":{"description":"Archive Error","type":"string","example":"Sample archive_error text content"}},"example":{"id":12345,"card_id":1,"name":"Example Name","ts":"2025-01-17T10:30:00Z","revision":123,"presentation":"example_presentation","external":1,"expire":"2025-01-17T10:30:00Z","stale":1,"currency":"USD","date_live":"2025-01-17T10:30:00Z","count":10,"live_rev_id":1,"billing_precision":1,"rounding_method":"up","duration_rounding_method":"up","origin_billing_source":"example_origin_billing_source","origin_billing_destination":"example_origin_billing_destination","storage":"live","archiving_at":"2025-01-17T10:30:00Z","archive_rule_count":10,"archive_sha256":"example_archive_sha256","archive_size":1000000,"archive_created_at":"2025-01-17T10:30:00Z","archive_deleted_at":"2025-01-17T10:30:00Z","archive_error":"Sample archive_error text content"},"required":["card_id","name","ts","revision","external","expire","stale","billing_precision","origin_billing_source","origin_billing_destination","storage"]},"routing":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"company_id":{"description":"Company Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":1},"card_id":{"description":"Card Id","type":"string","maxLength":255,"example":1},"prefix":{"description":"Prefix","type":"string","nullable":false,"maxLength":255,"example":"example_prefix"},"revision":{"description":"Revision","type":"integer","maxLength":11,"example":123},"channels":{"description":"Channels","type":"integer","nullable":false,"maxLength":11,"minimum":0,"default":"5","example":123},"cps":{"description":"Cps","type":"integer","maxLength":10,"minimum":0,"example":123},"cps_buffer":{"description":"Cps Buffer","type":"integer","maxLength":3,"minimum":0,"example":1},"max_duration":{"description":"Max Duration","type":"integer","maxLength":11,"default":"3600","example":123},"allow_ported":{"description":"Allow Ported","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"1","example":1},"transcoding":{"description":"Transcoding","type":"integer","maxLength":3,"minimum":0,"default":"0","example":1},"capped":{"description":"Capped","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"tps":{"description":"Tps","type":"integer","maxLength":10,"example":1},"asr_plus":{"description":"Asr Plus","type":"integer","maxLength":10,"default":"1","example":1},"recording":{"description":"Recording","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"recording_duration":{"description":"Recording Duration","type":"integer","maxLength":10,"minimum":0,"example":123},"transcribe":{"description":"Transcribe","type":"integer","nullable":false,"maxLength":255,"minimum":0,"default":"0","example":1},"transcribe_duration":{"description":"Transcribe Duration","type":"integer","maxLength":10,"minimum":0,"example":123},"rtp_proxy":{"description":"Rtp Proxy","type":"integer","nullable":false,"maxLength":50,"minimum":0,"default":"101","example":1},"rtp_mode":{"description":"Rtp Mode","type":"string","enum":["Relaxed","Strict"],"default":"Strict","example":"Relaxed"},"timeout":{"description":"Timeout","type":"array","items":{"type":"string","enum":["SIP Ping","RTP Proxy"]},"example":"SIP Ping"},"sip_ping":{"description":"Sip Ping","type":"integer","nullable":false,"maxLength":255,"minimum":0,"default":"1","example":1},"rtp_timeout":{"description":"Rtp Timeout","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"1","example":1},"sip_session_timers":{"description":"Sip Session Timers","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"fix_ok_cancel_race_uac_bug":{"description":"Fix Ok Cancel Race Uac Bug","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"pre_ring_timeout":{"description":"Pre Ring Timeout","type":"integer","maxLength":3,"minimum":0,"example":1},"post_ring_timeout":{"description":"Post Ring Timeout","type":"integer","maxLength":3,"minimum":0,"example":1},"fallthrough":{"description":"Fallthrough","type":"integer","nullable":false,"maxLength":4,"minimum":0,"default":"100","example":1},"carrier_list":{"description":"Carrier List","type":"string","maxLength":100,"example":"example_carrier_list"},"dialstring":{"description":"Dialstring","type":"string","maxLength":8000,"example":"example_dialstring"},"dialstring_prefix_set_id":{"description":"Dialstring Prefix Set Id","type":"integer","maxLength":10,"minimum":0,"example":1},"egress_group_id":{"description":"Egress Group Id","type":"integer","maxLength":10,"minimum":0,"example":1},"redirect_uri":{"description":"Redirect Uri","type":"string","maxLength":100,"example":"example_redirect_uri"},"redirect_exclude":{"description":"Redirect Exclude","type":"string","maxLength":50,"default":"404,408,486,487,603,604","example":"example_redirect_exclude"},"reply_map":{"description":"Reply Map","type":"string","maxLength":200,"example":"example_reply_map"},"capped_rate":{"description":"Capped Rate","type":"number","maxLength":8,"example":99.99},"capped_rate_prov":{"description":"Capped Rate Prov","type":"number","maxLength":8,"example":99.99},"block_connect_cost":{"description":"Block Connect Cost","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":99.99},"block_destination_type":{"description":"Block Destination Type","type":"string","maxLength":255,"example":"example_block_destination_type"},"spam_scout":{"description":"Spam Scout","type":"integer","maxLength":3,"minimum":0,"default":"100","example":1},"ipqs":{"description":"Ipqs","type":"integer","maxLength":3,"minimum":0,"example":1},"override_lcr":{"description":"Override Lcr","type":"string","maxLength":500,"example":"example_override_lcr"},"profit_assurance":{"description":"Profit Assurance","type":"number","maxLength":3,"example":99.99},"exclude_card":{"description":"Exclude Card","type":"string","maxLength":200,"example":"example_exclude_card"},"lock_card":{"description":"Lock Card","type":"string","maxLength":200,"example":"example_lock_card"},"sandbox_id":{"description":"Sandbox Id","type":"integer","maxLength":10,"example":1},"scriptforge_timeout":{"description":"Scriptforge Timeout","type":"number","maxLength":5,"minimum":0,"example":99.99},"scriptforge_timeout_action":{"description":"Scriptforge Timeout Action","type":"string","maxLength":50,"example":"example_scriptforge_timeout_action"},"vars":{"description":"Vars","type":"string","nullable":false,"maxLength":15000,"example":"example_vars"},"protocol":{"description":"Protocol","type":"string","enum":["SIP","SMPP"],"default":"SIP","example":"SIP"},"strategy":{"description":"Strategy","type":"object","additionalProperties":true,"maxLength":5000,"default":"[]","example":"example_strategy"},"remove_allow_inv":{"description":"Remove Allow Inv","type":"integer","maxLength":1,"minimum":0,"default":"0","example":1},"approved_by":{"description":"Approved By","type":"string","maxLength":255,"example":"example_approved_by"},"approved_date":{"description":"Approved Date","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"enabled":{"description":"Enabled","type":"integer","maxLength":3,"minimum":0,"default":"1","example":true},"auto":{"description":"Auto","type":"integer","maxLength":255,"minimum":0,"default":"0","example":1},"public_notes":{"description":"Public Notes","type":"string","example":"Sample public_notes text content"},"private_notes":{"description":"Private Notes","type":"string","example":"Sample private_notes text content"},"fraud_profile_id":{"description":"Fraud Profile Id","type":"integer","maxLength":10,"minimum":0,"example":1},"fraud_mode":{"description":"Fraud Mode","type":"integer","nullable":false,"maxLength":255,"minimum":0,"example":1},"ftc_dnc_report":{"description":"Ftc Dnc Report","type":"integer","maxLength":255,"minimum":0,"example":1},"dno":{"description":"Dno","type":"integer","maxLength":10,"minimum":0,"default":"0","example":123},"inter_customer":{"description":"Inter Customer","type":"integer","maxLength":255,"minimum":0,"default":"0","example":1},"dnc_list":{"description":"Dnc List","type":"string","maxLength":255,"example":"example_dnc_list"},"block_dtmf":{"description":"Block Dtmf","type":"integer","maxLength":255,"minimum":0,"default":"0","example":1},"realtime":{"description":"Realtime","type":"integer","maxLength":3,"minimum":0,"example":1},"redial_max_count":{"description":"Redial Max Count","type":"integer","maxLength":3,"minimum":0,"example":10},"redial_max_period":{"description":"Redial Max Period","type":"integer","maxLength":8,"minimum":0,"example":1000},"rtp_codec":{"description":"Rtp Codec","type":"object","additionalProperties":true,"maxLength":1500,"example":"example_rtp_codec"},"stir_shaken_min_attest":{"description":"Stir Shaken Min Attest","type":"string","enum":["A","B","C"],"example":"A"},"flags":{"description":"Flags","type":"string","nullable":false,"maxLength":255,"example":"example_flags"},"pbx_server":{"description":"Pbx Server","type":"string","maxLength":255,"example":"example_pbx_server"}},"example":{"id":12345,"company_id":1,"card_id":1,"prefix":"example_prefix","revision":123,"channels":123,"cps":123,"cps_buffer":1,"max_duration":123,"allow_ported":1,"transcoding":1,"capped":1,"tps":1,"asr_plus":1,"recording":1,"recording_duration":123,"transcribe":1,"transcribe_duration":123,"rtp_proxy":1,"rtp_mode":"Relaxed","timeout":"SIP Ping","sip_ping":1,"rtp_timeout":1,"sip_session_timers":1,"fix_ok_cancel_race_uac_bug":1,"pre_ring_timeout":1,"post_ring_timeout":1,"fallthrough":1,"carrier_list":"example_carrier_list","dialstring":"example_dialstring","dialstring_prefix_set_id":1,"egress_group_id":1,"redirect_uri":"example_redirect_uri","redirect_exclude":"example_redirect_exclude","reply_map":"example_reply_map","capped_rate":99.99,"capped_rate_prov":99.99,"block_connect_cost":99.99,"block_destination_type":"example_block_destination_type","spam_scout":1,"ipqs":1,"override_lcr":"example_override_lcr","profit_assurance":99.99,"exclude_card":"example_exclude_card","lock_card":"example_lock_card","sandbox_id":1,"scriptforge_timeout":99.99,"scriptforge_timeout_action":"example_scriptforge_timeout_action","vars":"example_vars","protocol":"SIP","strategy":"example_strategy","remove_allow_inv":1,"approved_by":"example_approved_by","approved_date":"2025-01-17T10:30:00Z","enabled":true,"auto":1,"public_notes":"Sample public_notes text content","private_notes":"Sample private_notes text content","fraud_profile_id":1,"fraud_mode":1,"ftc_dnc_report":1,"dno":123,"inter_customer":1,"dnc_list":"example_dnc_list","block_dtmf":1,"realtime":1,"redial_max_count":10,"redial_max_period":1000,"rtp_codec":"example_rtp_codec","stir_shaken_min_attest":"A","flags":"example_flags","pbx_server":"example_pbx_server"}},"routingInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"company_id":{"description":"Company Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":1},"card_id":{"description":"Card Id","type":"string","maxLength":255,"example":1},"prefix":{"description":"Prefix","type":"string","nullable":false,"maxLength":255,"example":"example_prefix"},"revision":{"description":"Revision","type":"integer","maxLength":11,"example":123},"channels":{"description":"Channels","type":"integer","nullable":false,"maxLength":11,"minimum":0,"default":"5","example":123},"cps":{"description":"Cps","type":"integer","maxLength":10,"minimum":0,"example":123},"cps_buffer":{"description":"Cps Buffer","type":"integer","maxLength":3,"minimum":0,"example":1},"max_duration":{"description":"Max Duration","type":"integer","maxLength":11,"default":"3600","example":123},"allow_ported":{"description":"Allow Ported","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"1","example":1},"transcoding":{"description":"Transcoding","type":"integer","maxLength":3,"minimum":0,"default":"0","example":1},"capped":{"description":"Capped","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"tps":{"description":"Tps","type":"integer","maxLength":10,"example":1},"asr_plus":{"description":"Asr Plus","type":"integer","maxLength":10,"default":"1","example":1},"recording":{"description":"Recording","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"recording_duration":{"description":"Recording Duration","type":"integer","maxLength":10,"minimum":0,"example":123},"transcribe":{"description":"Transcribe","type":"integer","nullable":false,"maxLength":255,"minimum":0,"default":"0","example":1},"transcribe_duration":{"description":"Transcribe Duration","type":"integer","maxLength":10,"minimum":0,"example":123},"rtp_proxy":{"description":"Rtp Proxy","type":"integer","nullable":false,"maxLength":50,"minimum":0,"default":"101","example":1},"rtp_mode":{"description":"Rtp Mode","type":"string","enum":["Relaxed","Strict"],"default":"Strict","example":"Relaxed"},"timeout":{"description":"Timeout","type":"array","items":{"type":"string","enum":["SIP Ping","RTP Proxy"]},"example":"SIP Ping"},"sip_ping":{"description":"Sip Ping","type":"integer","nullable":false,"maxLength":255,"minimum":0,"default":"1","example":1},"rtp_timeout":{"description":"Rtp Timeout","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"1","example":1},"sip_session_timers":{"description":"Sip Session Timers","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"fix_ok_cancel_race_uac_bug":{"description":"Fix Ok Cancel Race Uac Bug","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"pre_ring_timeout":{"description":"Pre Ring Timeout","type":"integer","maxLength":3,"minimum":0,"example":1},"post_ring_timeout":{"description":"Post Ring Timeout","type":"integer","maxLength":3,"minimum":0,"example":1},"fallthrough":{"description":"Fallthrough","type":"integer","nullable":false,"maxLength":4,"minimum":0,"default":"100","example":1},"carrier_list":{"description":"Carrier List","type":"string","maxLength":100,"example":"example_carrier_list"},"dialstring":{"description":"Dialstring","type":"string","maxLength":8000,"example":"example_dialstring"},"dialstring_prefix_set_id":{"description":"Dialstring Prefix Set Id","type":"integer","maxLength":10,"minimum":0,"example":1},"egress_group_id":{"description":"Egress Group Id","type":"integer","maxLength":10,"minimum":0,"example":1},"redirect_uri":{"description":"Redirect Uri","type":"string","maxLength":100,"example":"example_redirect_uri"},"redirect_exclude":{"description":"Redirect Exclude","type":"string","maxLength":50,"default":"404,408,486,487,603,604","example":"example_redirect_exclude"},"reply_map":{"description":"Reply Map","type":"string","maxLength":200,"example":"example_reply_map"},"capped_rate":{"description":"Capped Rate","type":"number","maxLength":8,"example":99.99},"capped_rate_prov":{"description":"Capped Rate Prov","type":"number","maxLength":8,"example":99.99},"block_connect_cost":{"description":"Block Connect Cost","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":99.99},"block_destination_type":{"description":"Block Destination Type","type":"string","maxLength":255,"example":"example_block_destination_type"},"spam_scout":{"description":"Spam Scout","type":"integer","maxLength":3,"minimum":0,"default":"100","example":1},"ipqs":{"description":"Ipqs","type":"integer","maxLength":3,"minimum":0,"example":1},"override_lcr":{"description":"Override Lcr","type":"string","maxLength":500,"example":"example_override_lcr"},"profit_assurance":{"description":"Profit Assurance","type":"number","maxLength":3,"example":99.99},"exclude_card":{"description":"Exclude Card","type":"string","maxLength":200,"example":"example_exclude_card"},"lock_card":{"description":"Lock Card","type":"string","maxLength":200,"example":"example_lock_card"},"sandbox_id":{"description":"Sandbox Id","type":"integer","maxLength":10,"example":1},"scriptforge_timeout":{"description":"Scriptforge Timeout","type":"number","maxLength":5,"minimum":0,"example":99.99},"scriptforge_timeout_action":{"description":"Scriptforge Timeout Action","type":"string","maxLength":50,"example":"example_scriptforge_timeout_action"},"vars":{"description":"Vars","type":"string","nullable":false,"maxLength":15000,"example":"example_vars"},"protocol":{"description":"Protocol","type":"string","enum":["SIP","SMPP"],"default":"SIP","example":"SIP"},"strategy":{"description":"Strategy","type":"object","additionalProperties":true,"maxLength":5000,"default":"[]","example":"example_strategy"},"remove_allow_inv":{"description":"Remove Allow Inv","type":"integer","maxLength":1,"minimum":0,"default":"0","example":1},"approved_by":{"description":"Approved By","type":"string","maxLength":255,"example":"example_approved_by"},"approved_date":{"description":"Approved Date","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"enabled":{"description":"Enabled","type":"integer","maxLength":3,"minimum":0,"default":"1","example":true},"auto":{"description":"Auto","type":"integer","maxLength":255,"minimum":0,"default":"0","example":1},"public_notes":{"description":"Public Notes","type":"string","example":"Sample public_notes text content"},"private_notes":{"description":"Private Notes","type":"string","example":"Sample private_notes text content"},"fraud_profile_id":{"description":"Fraud Profile Id","type":"integer","maxLength":10,"minimum":0,"example":1},"fraud_mode":{"description":"Fraud Mode","type":"integer","nullable":false,"maxLength":255,"minimum":0,"example":1},"ftc_dnc_report":{"description":"Ftc Dnc Report","type":"integer","maxLength":255,"minimum":0,"example":1},"dno":{"description":"Dno","type":"integer","maxLength":10,"minimum":0,"default":"0","example":123},"inter_customer":{"description":"Inter Customer","type":"integer","maxLength":255,"minimum":0,"default":"0","example":1},"dnc_list":{"description":"Dnc List","type":"string","maxLength":255,"example":"example_dnc_list"},"block_dtmf":{"description":"Block Dtmf","type":"integer","maxLength":255,"minimum":0,"default":"0","example":1},"realtime":{"description":"Realtime","type":"integer","maxLength":3,"minimum":0,"example":1},"redial_max_count":{"description":"Redial Max Count","type":"integer","maxLength":3,"minimum":0,"example":10},"redial_max_period":{"description":"Redial Max Period","type":"integer","maxLength":8,"minimum":0,"example":1000},"rtp_codec":{"description":"Rtp Codec","type":"object","additionalProperties":true,"maxLength":1500,"example":"example_rtp_codec"},"stir_shaken_min_attest":{"description":"Stir Shaken Min Attest","type":"string","enum":["A","B","C"],"example":"A"},"flags":{"description":"Flags","type":"string","nullable":false,"maxLength":255,"example":"example_flags"},"pbx_server":{"description":"Pbx Server","type":"string","maxLength":255,"example":"example_pbx_server"}},"example":{"id":12345,"company_id":1,"card_id":1,"prefix":"example_prefix","revision":123,"channels":123,"cps":123,"cps_buffer":1,"max_duration":123,"allow_ported":1,"transcoding":1,"capped":1,"tps":1,"asr_plus":1,"recording":1,"recording_duration":123,"transcribe":1,"transcribe_duration":123,"rtp_proxy":1,"rtp_mode":"Relaxed","timeout":"SIP Ping","sip_ping":1,"rtp_timeout":1,"sip_session_timers":1,"fix_ok_cancel_race_uac_bug":1,"pre_ring_timeout":1,"post_ring_timeout":1,"fallthrough":1,"carrier_list":"example_carrier_list","dialstring":"example_dialstring","dialstring_prefix_set_id":1,"egress_group_id":1,"redirect_uri":"example_redirect_uri","redirect_exclude":"example_redirect_exclude","reply_map":"example_reply_map","capped_rate":99.99,"capped_rate_prov":99.99,"block_connect_cost":99.99,"block_destination_type":"example_block_destination_type","spam_scout":1,"ipqs":1,"override_lcr":"example_override_lcr","profit_assurance":99.99,"exclude_card":"example_exclude_card","lock_card":"example_lock_card","sandbox_id":1,"scriptforge_timeout":99.99,"scriptforge_timeout_action":"example_scriptforge_timeout_action","vars":"example_vars","protocol":"SIP","strategy":"example_strategy","remove_allow_inv":1,"approved_by":"example_approved_by","approved_date":"2025-01-17T10:30:00Z","enabled":true,"auto":1,"public_notes":"Sample public_notes text content","private_notes":"Sample private_notes text content","fraud_profile_id":1,"fraud_mode":1,"ftc_dnc_report":1,"dno":123,"inter_customer":1,"dnc_list":"example_dnc_list","block_dtmf":1,"realtime":1,"redial_max_count":10,"redial_max_period":1000,"rtp_codec":"example_rtp_codec","stir_shaken_min_attest":"A","flags":"example_flags","pbx_server":"example_pbx_server"},"required":["company_id","prefix","channels","allow_ported","capped","recording","transcribe","rtp_proxy","sip_ping","rtp_timeout","sip_session_timers","fix_ok_cancel_race_uac_bug","fallthrough","block_connect_cost","vars","fraud_mode","flags"]},"sipDeviceLine":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"sip_device_id":{"description":"Sip Device Id (references sip_device.id)","type":"integer","maxLength":255,"minimum":0,"x-foreignKey":{"referencesTable":"sip_device","referencesColumn":"id"},"example":1},"line_idx":{"description":"Line Idx","type":"integer","nullable":false,"maxLength":255,"minimum":0,"default":"1","example":1},"display_name":{"description":"Display Name","type":"string","maxLength":255,"example":"example_display_name"},"cli":{"description":"Cli","type":"string","maxLength":255,"example":"example_cli"},"host":{"description":"Host","type":"string","maxLength":255,"example":"example_host"},"username":{"description":"Username","type":"string","maxLength":255,"example":"john_doe"},"password":{"description":"Password","type":"string","format":"password","maxLength":255,"example":"********"},"stun_server":{"description":"Stun Server","type":"string","maxLength":255,"example":"example_stun_server"},"proxy":{"description":"Proxy","type":"string","maxLength":255,"example":"example_proxy"},"vars":{"description":"Vars","type":"string","maxLength":255,"example":"example_vars"}},"example":{"id":12345,"sip_device_id":1,"line_idx":1,"display_name":"example_display_name","cli":"example_cli","host":"example_host","username":"john_doe","password":"********","stun_server":"example_stun_server","proxy":"example_proxy","vars":"example_vars"}},"sipDeviceLineInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"sip_device_id":{"description":"Sip Device Id (references sip_device.id)","type":"integer","maxLength":255,"minimum":0,"x-foreignKey":{"referencesTable":"sip_device","referencesColumn":"id"},"example":1},"line_idx":{"description":"Line Idx","type":"integer","nullable":false,"maxLength":255,"minimum":0,"default":"1","example":1},"display_name":{"description":"Display Name","type":"string","maxLength":255,"example":"example_display_name"},"cli":{"description":"Cli","type":"string","maxLength":255,"example":"example_cli"},"host":{"description":"Host","type":"string","maxLength":255,"example":"example_host"},"username":{"description":"Username","type":"string","maxLength":255,"example":"john_doe"},"password":{"description":"Password","type":"string","format":"password","maxLength":255,"example":"********"},"stun_server":{"description":"Stun Server","type":"string","maxLength":255,"example":"example_stun_server"},"proxy":{"description":"Proxy","type":"string","maxLength":255,"example":"example_proxy"},"vars":{"description":"Vars","type":"string","maxLength":255,"example":"example_vars"}},"example":{"id":12345,"sip_device_id":1,"line_idx":1,"display_name":"example_display_name","cli":"example_cli","host":"example_host","username":"john_doe","password":"********","stun_server":"example_stun_server","proxy":"example_proxy","vars":"example_vars"},"required":["line_idx"]},"transformation":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"card_id":{"description":"Card Id","type":"string","nullable":false,"maxLength":10,"example":1},"prefix":{"description":"Prefix","type":"string","maxLength":5000,"example":"example_prefix"},"prefix_set_id":{"description":"Prefix Set Id","type":"integer","maxLength":10,"minimum":0,"example":1},"profit_type":{"description":"Profit Type","type":"string","enum":["absolute","relative","percent"],"default":"absolute","example":"absolute"},"cost":{"description":"Cost","type":"number","maxLength":9,"example":99.99},"percent":{"description":"Percent","type":"number","maxLength":6,"example":99.99},"edit_max_cost":{"description":"Edit Max Cost","type":"number","maxLength":8,"example":99.99},"priority":{"description":"Priority","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"1","example":1},"new_name":{"description":"New Name","type":"string","maxLength":250,"example":"example_new_name"},"mcd":{"description":"Mcd","type":"integer","maxLength":3,"minimum":0,"default":"1","example":1},"pulse":{"description":"Pulse","type":"integer","maxLength":3,"minimum":0,"default":"1","example":1},"cost_connect":{"description":"Cost Connect","type":"number","maxLength":8,"minimum":0,"example":99.99},"rounding":{"description":"Rounding","type":"integer","maxLength":11,"minimum":0,"default":"4","example":1},"apply_to":{"description":"Apply To","type":"string","maxLength":200,"example":"example_apply_to"},"action":{"description":"Action","type":"string","maxLength":50,"example":"example_action"},"status":{"description":"Status","type":"string","maxLength":50,"default":"profit","example":"Active"}},"example":{"id":12345,"card_id":1,"prefix":"example_prefix","prefix_set_id":1,"profit_type":"absolute","cost":99.99,"percent":99.99,"edit_max_cost":99.99,"priority":1,"new_name":"example_new_name","mcd":1,"pulse":1,"cost_connect":99.99,"rounding":1,"apply_to":"example_apply_to","action":"example_action","status":"Active"}},"transformationInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"card_id":{"description":"Card Id","type":"string","nullable":false,"maxLength":10,"example":1},"prefix":{"description":"Prefix","type":"string","maxLength":5000,"example":"example_prefix"},"prefix_set_id":{"description":"Prefix Set Id","type":"integer","maxLength":10,"minimum":0,"example":1},"profit_type":{"description":"Profit Type","type":"string","enum":["absolute","relative","percent"],"default":"absolute","example":"absolute"},"cost":{"description":"Cost","type":"number","maxLength":9,"example":99.99},"percent":{"description":"Percent","type":"number","maxLength":6,"example":99.99},"edit_max_cost":{"description":"Edit Max Cost","type":"number","maxLength":8,"example":99.99},"priority":{"description":"Priority","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"1","example":1},"new_name":{"description":"New Name","type":"string","maxLength":250,"example":"example_new_name"},"mcd":{"description":"Mcd","type":"integer","maxLength":3,"minimum":0,"default":"1","example":1},"pulse":{"description":"Pulse","type":"integer","maxLength":3,"minimum":0,"default":"1","example":1},"cost_connect":{"description":"Cost Connect","type":"number","maxLength":8,"minimum":0,"example":99.99},"rounding":{"description":"Rounding","type":"integer","maxLength":11,"minimum":0,"default":"4","example":1},"apply_to":{"description":"Apply To","type":"string","maxLength":200,"example":"example_apply_to"},"action":{"description":"Action","type":"string","maxLength":50,"example":"example_action"},"status":{"description":"Status","type":"string","maxLength":50,"default":"profit","example":"Active"}},"example":{"id":12345,"card_id":1,"prefix":"example_prefix","prefix_set_id":1,"profit_type":"absolute","cost":99.99,"percent":99.99,"edit_max_cost":99.99,"priority":1,"new_name":"example_new_name","mcd":1,"pulse":1,"cost_connect":99.99,"rounding":1,"apply_to":"example_apply_to","action":"example_action","status":"Active"},"required":["card_id","priority"]},"switch":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"company_id":{"description":"Company Id (references company.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"company","referencesColumn":"id"},"example":1},"ip":{"description":"Ip","type":"string","format":"ipv4","maxLength":255,"example":"192.168.1.1"},"proxy":{"description":"Proxy","type":"string","maxLength":255,"example":"example_proxy"},"bandwidth":{"description":"Bandwidth","type":"integer","maxLength":11,"example":123},"channels":{"description":"Channels","type":"integer","maxLength":11,"example":123},"cps":{"description":"Cps","type":"integer","maxLength":11,"example":123},"manufacturer":{"description":"Manufacturer","type":"string","maxLength":50,"example":"example_manufacturer"},"version":{"description":"Version","type":"string","maxLength":30,"example":"example_version"},"protocol":{"description":"Protocol","type":"string","maxLength":15,"example":"example_protocol"},"port":{"description":"Port","type":"string","maxLength":5,"example":"example_port"},"codec":{"description":"Codec","type":"string","maxLength":300,"example":"example_codec"},"dial_pattern":{"description":"Dial Pattern","type":"string","maxLength":20,"example":"example_dial_pattern"},"prefix":{"description":"Prefix","type":"string","nullable":false,"maxLength":20,"example":"example_prefix"},"cli_prefix":{"description":"Cli Prefix","type":"string","maxLength":20,"example":"example_cli_prefix"},"strip":{"description":"Strip","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":123},"cli_strip":{"description":"Cli Strip","type":"integer","nullable":false,"maxLength":10,"example":123},"direction":{"description":"Direction","type":"array","items":{"type":"string","enum":["Ingress","Egress"]},"default":"","example":"Ingress"},"user":{"description":"User","type":"string","maxLength":50,"example":"example_user"},"pass":{"description":"Pass","type":"string","maxLength":50,"example":"example_pass"},"from":{"description":"From","type":"string","maxLength":100,"example":"example_from"},"rewrite":{"description":"Rewrite","type":"object","additionalProperties":true,"maxLength":3000,"example":"example_rewrite"},"force_nat":{"description":"Force Nat","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"intercept_reinvite":{"description":"Intercept Reinvite","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"flags":{"description":"Flags","type":"string","nullable":false,"maxLength":255,"default":"","example":"example_flags"},"weight":{"description":"Weight","type":"integer","maxLength":3,"minimum":0,"default":"1","example":1},"start_ip":{"description":"Start Ip","type":"integer","format":"ipv4","maxLength":10,"minimum":0,"example":123},"end_ip":{"description":"End Ip","type":"integer","format":"ipv4","maxLength":10,"minimum":0,"example":123},"iso3166_alpha_2":{"description":"Iso 3166 Alpha 2","type":"string","maxLength":2,"example":"example_iso3166_alpha_2"}},"example":{"id":12345,"company_id":1,"ip":"192.168.1.1","proxy":"example_proxy","bandwidth":123,"channels":123,"cps":123,"manufacturer":"example_manufacturer","version":"example_version","protocol":"example_protocol","port":"example_port","codec":"example_codec","dial_pattern":"example_dial_pattern","prefix":"example_prefix","cli_prefix":"example_cli_prefix","strip":123,"cli_strip":123,"direction":"Ingress","user":"example_user","pass":"example_pass","from":"example_from","rewrite":"example_rewrite","force_nat":1,"intercept_reinvite":1,"flags":"example_flags","weight":1,"start_ip":123,"end_ip":123,"iso3166_alpha_2":"example_iso3166_alpha_2"}},"switchInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"company_id":{"description":"Company Id (references company.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"company","referencesColumn":"id"},"example":1},"ip":{"description":"Ip","type":"string","format":"ipv4","maxLength":255,"example":"192.168.1.1"},"proxy":{"description":"Proxy","type":"string","maxLength":255,"example":"example_proxy"},"bandwidth":{"description":"Bandwidth","type":"integer","maxLength":11,"example":123},"channels":{"description":"Channels","type":"integer","maxLength":11,"example":123},"cps":{"description":"Cps","type":"integer","maxLength":11,"example":123},"manufacturer":{"description":"Manufacturer","type":"string","maxLength":50,"example":"example_manufacturer"},"version":{"description":"Version","type":"string","maxLength":30,"example":"example_version"},"protocol":{"description":"Protocol","type":"string","maxLength":15,"example":"example_protocol"},"port":{"description":"Port","type":"string","maxLength":5,"example":"example_port"},"codec":{"description":"Codec","type":"string","maxLength":300,"example":"example_codec"},"dial_pattern":{"description":"Dial Pattern","type":"string","maxLength":20,"example":"example_dial_pattern"},"prefix":{"description":"Prefix","type":"string","nullable":false,"maxLength":20,"example":"example_prefix"},"cli_prefix":{"description":"Cli Prefix","type":"string","maxLength":20,"example":"example_cli_prefix"},"strip":{"description":"Strip","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":123},"cli_strip":{"description":"Cli Strip","type":"integer","nullable":false,"maxLength":10,"example":123},"direction":{"description":"Direction","type":"array","items":{"type":"string","enum":["Ingress","Egress"]},"default":"","example":"Ingress"},"user":{"description":"User","type":"string","maxLength":50,"example":"example_user"},"pass":{"description":"Pass","type":"string","maxLength":50,"example":"example_pass"},"from":{"description":"From","type":"string","maxLength":100,"example":"example_from"},"rewrite":{"description":"Rewrite","type":"object","additionalProperties":true,"maxLength":3000,"example":"example_rewrite"},"force_nat":{"description":"Force Nat","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"intercept_reinvite":{"description":"Intercept Reinvite","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"flags":{"description":"Flags","type":"string","nullable":false,"maxLength":255,"default":"","example":"example_flags"},"weight":{"description":"Weight","type":"integer","maxLength":3,"minimum":0,"default":"1","example":1},"start_ip":{"description":"Start Ip","type":"integer","format":"ipv4","maxLength":10,"minimum":0,"example":123},"end_ip":{"description":"End Ip","type":"integer","format":"ipv4","maxLength":10,"minimum":0,"example":123},"iso3166_alpha_2":{"description":"Iso 3166 Alpha 2","type":"string","maxLength":2,"example":"example_iso3166_alpha_2"}},"example":{"id":12345,"company_id":1,"ip":"192.168.1.1","proxy":"example_proxy","bandwidth":123,"channels":123,"cps":123,"manufacturer":"example_manufacturer","version":"example_version","protocol":"example_protocol","port":"example_port","codec":"example_codec","dial_pattern":"example_dial_pattern","prefix":"example_prefix","cli_prefix":"example_cli_prefix","strip":123,"cli_strip":123,"direction":"Ingress","user":"example_user","pass":"example_pass","from":"example_from","rewrite":"example_rewrite","force_nat":1,"intercept_reinvite":1,"flags":"example_flags","weight":1,"start_ip":123,"end_ip":123,"iso3166_alpha_2":"example_iso3166_alpha_2"},"required":["prefix","strip","cli_strip","force_nat","intercept_reinvite","flags"]},"sipUser":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"company_id":{"description":"Company Id (references company.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"company","referencesColumn":"id"},"example":1},"username":{"description":"Username","type":"string","maxLength":255,"example":"john_doe"},"password":{"description":"Password","type":"string","format":"password","maxLength":255,"example":"********"},"bandwidth":{"description":"Bandwidth","type":"integer","maxLength":11,"example":123},"channels":{"description":"Channels","type":"integer","maxLength":11,"example":123},"cps":{"description":"Cps","type":"integer","maxLength":11,"example":123},"protocol":{"description":"Protocol","type":"string","maxLength":20,"example":"example_protocol"},"codec":{"description":"Codec","type":"string","maxLength":300,"example":"example_codec"},"dial_pattern":{"description":"Dial Pattern","type":"string","maxLength":20,"example":"example_dial_pattern"},"prefix":{"description":"Prefix","type":"string","maxLength":20,"example":"example_prefix"},"cli_prefix":{"description":"Cli Prefix","type":"string","maxLength":20,"example":"example_cli_prefix"},"strip":{"description":"Strip","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":123},"status":{"description":"Status","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":"Active"},"rewrite":{"description":"Rewrite","type":"object","additionalProperties":true,"maxLength":3000,"default":"[]","example":"example_rewrite"},"voicemail":{"description":"Voicemail","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"voicemail_password":{"description":"Voicemail Password","type":"string","format":"password","nullable":false,"maxLength":10,"example":"example_voicemail_password"},"ip_whitelist":{"description":"Ip Whitelist","type":"string","maxLength":1000,"example":"example_ip_whitelist"},"email":{"description":"Email","type":"string","format":"email","maxLength":100,"example":"user@example.com"},"sip_ping":{"description":"Sip Ping","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":1},"smart":{"description":"Smart","type":"integer","nullable":false,"maxLength":255,"minimum":0,"default":"0","example":1},"retain_did":{"description":"Retain Did","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"sip_profile_id":{"description":"Sip Profile Id","type":"integer","maxLength":10,"minimum":0,"example":1},"address_number":{"description":"Address Number","type":"string","maxLength":255,"example":"example_address_number"},"street_name":{"description":"Street Name","type":"string","maxLength":255,"example":"example_street_name"},"city":{"description":"City","type":"string","maxLength":255,"example":"example_city"},"state":{"description":"State","type":"string","maxLength":255,"example":"example_state"},"post_code":{"description":"Post Code","type":"string","maxLength":255,"example":"example_post_code"}},"example":{"id":12345,"company_id":1,"username":"john_doe","password":"********","bandwidth":123,"channels":123,"cps":123,"protocol":"example_protocol","codec":"example_codec","dial_pattern":"example_dial_pattern","prefix":"example_prefix","cli_prefix":"example_cli_prefix","strip":123,"status":"Active","rewrite":"example_rewrite","voicemail":1,"voicemail_password":"example_voicemail_password","ip_whitelist":"example_ip_whitelist","email":"user@example.com","sip_ping":1,"smart":1,"retain_did":1,"sip_profile_id":1,"address_number":"example_address_number","street_name":"example_street_name","city":"example_city","state":"example_state","post_code":"example_post_code"}},"sipUserInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"company_id":{"description":"Company Id (references company.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"company","referencesColumn":"id"},"example":1},"username":{"description":"Username","type":"string","maxLength":255,"example":"john_doe"},"password":{"description":"Password","type":"string","format":"password","maxLength":255,"example":"********"},"bandwidth":{"description":"Bandwidth","type":"integer","maxLength":11,"example":123},"channels":{"description":"Channels","type":"integer","maxLength":11,"example":123},"cps":{"description":"Cps","type":"integer","maxLength":11,"example":123},"protocol":{"description":"Protocol","type":"string","maxLength":20,"example":"example_protocol"},"codec":{"description":"Codec","type":"string","maxLength":300,"example":"example_codec"},"dial_pattern":{"description":"Dial Pattern","type":"string","maxLength":20,"example":"example_dial_pattern"},"prefix":{"description":"Prefix","type":"string","maxLength":20,"example":"example_prefix"},"cli_prefix":{"description":"Cli Prefix","type":"string","maxLength":20,"example":"example_cli_prefix"},"strip":{"description":"Strip","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":123},"status":{"description":"Status","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":"Active"},"rewrite":{"description":"Rewrite","type":"object","additionalProperties":true,"maxLength":3000,"default":"[]","example":"example_rewrite"},"voicemail":{"description":"Voicemail","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"voicemail_password":{"description":"Voicemail Password","type":"string","format":"password","nullable":false,"maxLength":10,"example":"example_voicemail_password"},"ip_whitelist":{"description":"Ip Whitelist","type":"string","maxLength":1000,"example":"example_ip_whitelist"},"email":{"description":"Email","type":"string","format":"email","maxLength":100,"example":"user@example.com"},"sip_ping":{"description":"Sip Ping","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":1},"smart":{"description":"Smart","type":"integer","nullable":false,"maxLength":255,"minimum":0,"default":"0","example":1},"retain_did":{"description":"Retain Did","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"sip_profile_id":{"description":"Sip Profile Id","type":"integer","maxLength":10,"minimum":0,"example":1},"address_number":{"description":"Address Number","type":"string","maxLength":255,"example":"example_address_number"},"street_name":{"description":"Street Name","type":"string","maxLength":255,"example":"example_street_name"},"city":{"description":"City","type":"string","maxLength":255,"example":"example_city"},"state":{"description":"State","type":"string","maxLength":255,"example":"example_state"},"post_code":{"description":"Post Code","type":"string","maxLength":255,"example":"example_post_code"}},"example":{"id":12345,"company_id":1,"username":"john_doe","password":"********","bandwidth":123,"channels":123,"cps":123,"protocol":"example_protocol","codec":"example_codec","dial_pattern":"example_dial_pattern","prefix":"example_prefix","cli_prefix":"example_cli_prefix","strip":123,"status":"Active","rewrite":"example_rewrite","voicemail":1,"voicemail_password":"example_voicemail_password","ip_whitelist":"example_ip_whitelist","email":"user@example.com","sip_ping":1,"smart":1,"retain_did":1,"sip_profile_id":1,"address_number":"example_address_number","street_name":"example_street_name","city":"example_city","state":"example_state","post_code":"example_post_code"},"required":["strip","status","voicemail","voicemail_password","sip_ping","smart","retain_did"]},"smsUser":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"company_id":{"description":"Company Id (references company.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"company","referencesColumn":"id"},"example":1},"username":{"description":"Username (unique)","type":"string","maxLength":255,"x-unique":true,"example":"john_doe"},"hash":{"description":"Hash","type":"string","maxLength":255,"example":"example_hash"},"protocol":{"description":"Protocol","type":"array","items":{"type":"string","enum":["http","smpp"]},"default":"","example":"http"}},"example":{"id":12345,"company_id":1,"username":"john_doe","hash":"example_hash","protocol":"http"}},"smsUserInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"company_id":{"description":"Company Id (references company.id)","type":"integer","maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"company","referencesColumn":"id"},"example":1},"username":{"description":"Username (unique)","type":"string","maxLength":255,"x-unique":true,"example":"john_doe"},"hash":{"description":"Hash","type":"string","maxLength":255,"example":"example_hash"},"protocol":{"description":"Protocol","type":"array","items":{"type":"string","enum":["http","smpp"]},"default":"","example":"http"}},"example":{"id":12345,"company_id":1,"username":"john_doe","hash":"example_hash","protocol":"http"}},"setupAccountManagerComission":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"created_at":{"description":"Created At","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"user_id":{"description":"User Id","type":"integer","maxLength":11,"minimum":0,"example":1},"amount":{"description":"Amount","type":"number","nullable":false,"maxLength":10,"example":99.99},"currency":{"description":"Currency","type":"string","nullable":false,"maxLength":3,"default":"USD","example":"USD"},"description":{"description":"Description","type":"string","maxLength":255,"example":"A detailed description of the resource"}},"example":{"id":12345,"created_at":"2025-01-17T10:30:00Z","user_id":1,"amount":99.99,"currency":"USD","description":"A detailed description of the resource"}},"setupAccountManagerComissionInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"created_at":{"description":"Created At","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"user_id":{"description":"User Id","type":"integer","maxLength":11,"minimum":0,"example":1},"amount":{"description":"Amount","type":"number","nullable":false,"maxLength":10,"example":99.99},"currency":{"description":"Currency","type":"string","nullable":false,"maxLength":3,"default":"USD","example":"USD"},"description":{"description":"Description","type":"string","maxLength":255,"example":"A detailed description of the resource"}},"example":{"id":12345,"created_at":"2025-01-17T10:30:00Z","user_id":1,"amount":99.99,"currency":"USD","description":"A detailed description of the resource"},"required":["amount","currency"]},"anycastLoadbalancerDestination":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"anycast_dispatcher_id":{"description":"Anycast Dispatcher Id (references anycast_dispatcher.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"anycast_dispatcher","referencesColumn":"id"},"example":1},"destination":{"description":"Destination","type":"string","nullable":false,"maxLength":255,"example":"example_destination"},"proto":{"description":"Proto","type":"string","enum":["default","udp","tcp"],"nullable":false,"default":"default","example":"default"},"weight":{"description":"Weight","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"priority":{"description":"Priority","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"state":{"description":"State","type":"string","enum":["Active","Inactive","Probing"],"nullable":false,"default":"Active","example":"Active"},"zone":{"description":"Zone","type":"string","nullable":false,"maxLength":255,"example":"example_zone"},"backup_zone":{"description":"Backup Zone","type":"string","nullable":false,"maxLength":255,"example":"example_backup_zone"}},"example":{"id":12345,"anycast_dispatcher_id":1,"destination":"example_destination","proto":"default","weight":1,"priority":1,"state":"Active","zone":"example_zone","backup_zone":"example_backup_zone"}},"anycastLoadbalancerDestinationInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"anycast_dispatcher_id":{"description":"Anycast Dispatcher Id (references anycast_dispatcher.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"anycast_dispatcher","referencesColumn":"id"},"example":1},"destination":{"description":"Destination","type":"string","nullable":false,"maxLength":255,"example":"example_destination"},"proto":{"description":"Proto","type":"string","enum":["default","udp","tcp"],"nullable":false,"default":"default","example":"default"},"weight":{"description":"Weight","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"priority":{"description":"Priority","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"0","example":1},"state":{"description":"State","type":"string","enum":["Active","Inactive","Probing"],"nullable":false,"default":"Active","example":"Active"},"zone":{"description":"Zone","type":"string","nullable":false,"maxLength":255,"example":"example_zone"},"backup_zone":{"description":"Backup Zone","type":"string","nullable":false,"maxLength":255,"example":"example_backup_zone"}},"example":{"id":12345,"anycast_dispatcher_id":1,"destination":"example_destination","proto":"default","weight":1,"priority":1,"state":"Active","zone":"example_zone","backup_zone":"example_backup_zone"},"required":["anycast_dispatcher_id","destination","proto","weight","priority","state","zone","backup_zone"]},"anyEdgeDomain":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"anycast_dispatcher_id":{"description":"Anycast Dispatcher Id (references anycast_dispatcher.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"anycast_dispatcher","referencesColumn":"id"},"example":1},"domain":{"description":"Domain (unique)","type":"string","maxLength":255,"x-unique":true,"example":"example_domain"},"status":{"description":"Status","type":"string","enum":["Pending","Ready","Error"],"nullable":false,"default":"Pending","example":"Pending"},"method":{"description":"Method","type":"string","enum":["SSLv23","SSLv3","TLSv1","TLSv1_2","none"],"nullable":false,"example":"SSLv23"},"verify_cert":{"description":"Verify Cert","type":"integer","nullable":false,"maxLength":2,"minimum":0,"example":1},"require_cert":{"description":"Require Cert","type":"integer","maxLength":2,"example":1},"cipher_list":{"description":"Cipher List","type":"string","maxLength":2000,"example":"example_cipher_list"},"ec_curve":{"description":"Ec Curve","type":"string","maxLength":2000,"example":"example_ec_curve"},"uac_test":{"description":"Uac Test","type":"string","maxLength":100,"default":"19","example":"example_uac_test"},"alg":{"description":"Alg","type":"integer","maxLength":3,"default":"0","example":1},"cps":{"description":"Cps","type":"integer","maxLength":10,"minimum":0,"default":"100","example":123},"validate":{"description":"Validate","type":"string","nullable":false,"maxLength":10,"example":"example_validate"},"compress_in":{"description":"Compress In","type":"string","nullable":false,"maxLength":1000,"example":"example_compress_in"},"compress_out":{"description":"Compress Out","type":"string","nullable":false,"maxLength":1000,"example":"example_compress_out"},"insertion":{"description":"Insertion","type":"string","enum":["stateless","transactional","dialog"],"default":"stateless","example":"stateless"},"flags":{"description":"Flags","type":"string","maxLength":255,"example":"example_flags"},"last_updated":{"description":"Last Updated","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"primary_attempts":{"description":"Primary Attempts","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"2","example":1},"secondary_attempts":{"description":"Secondary Attempts","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"2","example":1}},"example":{"id":12345,"anycast_dispatcher_id":1,"domain":"example_domain","status":"Pending","method":"SSLv23","verify_cert":1,"require_cert":1,"cipher_list":"example_cipher_list","ec_curve":"example_ec_curve","uac_test":"example_uac_test","alg":1,"cps":123,"validate":"example_validate","compress_in":"example_compress_in","compress_out":"example_compress_out","insertion":"stateless","flags":"example_flags","last_updated":"2025-01-17T10:30:00Z","primary_attempts":1,"secondary_attempts":1}},"anyEdgeDomainInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"anycast_dispatcher_id":{"description":"Anycast Dispatcher Id (references anycast_dispatcher.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"anycast_dispatcher","referencesColumn":"id"},"example":1},"domain":{"description":"Domain (unique)","type":"string","maxLength":255,"x-unique":true,"example":"example_domain"},"status":{"description":"Status","type":"string","enum":["Pending","Ready","Error"],"nullable":false,"default":"Pending","example":"Pending"},"method":{"description":"Method","type":"string","enum":["SSLv23","SSLv3","TLSv1","TLSv1_2","none"],"nullable":false,"example":"SSLv23"},"verify_cert":{"description":"Verify Cert","type":"integer","nullable":false,"maxLength":2,"minimum":0,"example":1},"require_cert":{"description":"Require Cert","type":"integer","maxLength":2,"example":1},"cipher_list":{"description":"Cipher List","type":"string","maxLength":2000,"example":"example_cipher_list"},"ec_curve":{"description":"Ec Curve","type":"string","maxLength":2000,"example":"example_ec_curve"},"uac_test":{"description":"Uac Test","type":"string","maxLength":100,"default":"19","example":"example_uac_test"},"alg":{"description":"Alg","type":"integer","maxLength":3,"default":"0","example":1},"cps":{"description":"Cps","type":"integer","maxLength":10,"minimum":0,"default":"100","example":123},"validate":{"description":"Validate","type":"string","nullable":false,"maxLength":10,"example":"example_validate"},"compress_in":{"description":"Compress In","type":"string","nullable":false,"maxLength":1000,"example":"example_compress_in"},"compress_out":{"description":"Compress Out","type":"string","nullable":false,"maxLength":1000,"example":"example_compress_out"},"insertion":{"description":"Insertion","type":"string","enum":["stateless","transactional","dialog"],"default":"stateless","example":"stateless"},"flags":{"description":"Flags","type":"string","maxLength":255,"example":"example_flags"},"last_updated":{"description":"Last Updated","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"primary_attempts":{"description":"Primary Attempts","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"2","example":1},"secondary_attempts":{"description":"Secondary Attempts","type":"integer","nullable":false,"maxLength":3,"minimum":0,"default":"2","example":1}},"example":{"id":12345,"anycast_dispatcher_id":1,"domain":"example_domain","status":"Pending","method":"SSLv23","verify_cert":1,"require_cert":1,"cipher_list":"example_cipher_list","ec_curve":"example_ec_curve","uac_test":"example_uac_test","alg":1,"cps":123,"validate":"example_validate","compress_in":"example_compress_in","compress_out":"example_compress_out","insertion":"stateless","flags":"example_flags","last_updated":"2025-01-17T10:30:00Z","primary_attempts":1,"secondary_attempts":1},"required":["anycast_dispatcher_id","status","method","verify_cert","validate","compress_in","compress_out","primary_attempts","secondary_attempts"]},"setupUserCertification":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"user_id":{"description":"User Id","type":"integer","maxLength":11,"example":1},"name":{"description":"Name","type":"string","maxLength":255,"example":"Example Name"},"pass_date":{"description":"Pass Date","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"notes":{"description":"Notes","type":"string","example":"Sample notes text content"},"provided_by":{"description":"Provided By","type":"string","maxLength":255,"example":"example_provided_by"},"user_email":{"description":"User Email","type":"string","format":"email","maxLength":255,"example":"example_user_email"}},"example":{"id":12345,"user_id":1,"name":"Example Name","pass_date":"2025-01-17T10:30:00Z","notes":"Sample notes text content","provided_by":"example_provided_by","user_email":"example_user_email"}},"fraudRule":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"fraud_profile_id":{"description":"Fraud Profile Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":1},"prefix":{"description":"Prefix","type":"string","nullable":false,"maxLength":64,"example":"example_prefix"},"start_hour":{"description":"Start Hour","type":"string","nullable":false,"maxLength":5,"default":"00:00","example":"example_start_hour"},"end_hour":{"description":"End Hour","type":"string","nullable":false,"maxLength":5,"default":"23:59","example":"example_end_hour"},"daysoftheweek":{"description":"Daysoftheweek","type":"string","nullable":false,"maxLength":64,"default":"Mon-Sun","example":"example_daysoftheweek"},"cpm_warning":{"description":"Cpm Warning","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"0","example":123},"cpm_critical":{"description":"Cpm Critical","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"0","example":123},"call_duration_warning":{"description":"Call Duration Warning","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"0","example":123},"call_duration_critical":{"description":"Call Duration Critical","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"0","example":123},"total_calls_warning":{"description":"Total Calls Warning","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"0","example":10},"total_calls_critical":{"description":"Total Calls Critical","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"0","example":10},"concurrent_calls_warning":{"description":"Concurrent Calls Warning","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"0","example":123},"concurrent_calls_critical":{"description":"Concurrent Calls Critical","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"0","example":123},"sequential_calls_warning":{"description":"Sequential Calls Warning","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"0","example":123},"sequential_calls_critical":{"description":"Sequential Calls Critical","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"0","example":123}},"example":{"id":12345,"fraud_profile_id":1,"prefix":"example_prefix","start_hour":"example_start_hour","end_hour":"example_end_hour","daysoftheweek":"example_daysoftheweek","cpm_warning":123,"cpm_critical":123,"call_duration_warning":123,"call_duration_critical":123,"total_calls_warning":10,"total_calls_critical":10,"concurrent_calls_warning":123,"concurrent_calls_critical":123,"sequential_calls_warning":123,"sequential_calls_critical":123}},"fraudRuleInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"fraud_profile_id":{"description":"Fraud Profile Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":1},"prefix":{"description":"Prefix","type":"string","nullable":false,"maxLength":64,"example":"example_prefix"},"start_hour":{"description":"Start Hour","type":"string","nullable":false,"maxLength":5,"default":"00:00","example":"example_start_hour"},"end_hour":{"description":"End Hour","type":"string","nullable":false,"maxLength":5,"default":"23:59","example":"example_end_hour"},"daysoftheweek":{"description":"Daysoftheweek","type":"string","nullable":false,"maxLength":64,"default":"Mon-Sun","example":"example_daysoftheweek"},"cpm_warning":{"description":"Cpm Warning","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"0","example":123},"cpm_critical":{"description":"Cpm Critical","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"0","example":123},"call_duration_warning":{"description":"Call Duration Warning","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"0","example":123},"call_duration_critical":{"description":"Call Duration Critical","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"0","example":123},"total_calls_warning":{"description":"Total Calls Warning","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"0","example":10},"total_calls_critical":{"description":"Total Calls Critical","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"0","example":10},"concurrent_calls_warning":{"description":"Concurrent Calls Warning","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"0","example":123},"concurrent_calls_critical":{"description":"Concurrent Calls Critical","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"0","example":123},"sequential_calls_warning":{"description":"Sequential Calls Warning","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"0","example":123},"sequential_calls_critical":{"description":"Sequential Calls Critical","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"0","example":123}},"example":{"id":12345,"fraud_profile_id":1,"prefix":"example_prefix","start_hour":"example_start_hour","end_hour":"example_end_hour","daysoftheweek":"example_daysoftheweek","cpm_warning":123,"cpm_critical":123,"call_duration_warning":123,"call_duration_critical":123,"total_calls_warning":10,"total_calls_critical":10,"concurrent_calls_warning":123,"concurrent_calls_critical":123,"sequential_calls_warning":123,"sequential_calls_critical":123},"required":["fraud_profile_id","prefix","start_hour","end_hour","daysoftheweek","cpm_warning","cpm_critical","call_duration_warning","call_duration_critical","total_calls_warning","total_calls_critical","concurrent_calls_warning","concurrent_calls_critical","sequential_calls_warning","sequential_calls_critical"]},"setupGroupPermission":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"group_id":{"description":"Group Id","type":"integer","maxLength":11,"minimum":0,"example":1},"path":{"description":"Path","type":"string","maxLength":255,"example":"example_path"},"access":{"description":"Access","type":"array","items":{"type":"string","enum":["get","put","post","delete"]},"default":"","example":"get"}},"example":{"id":12345,"group_id":1,"path":"example_path","access":"get"}},"setupGroupPermissionInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":11,"minimum":0,"example":12345},"group_id":{"description":"Group Id","type":"integer","maxLength":11,"minimum":0,"example":1},"path":{"description":"Path","type":"string","maxLength":255,"example":"example_path"},"access":{"description":"Access","type":"array","items":{"type":"string","enum":["get","put","post","delete"]},"default":"","example":"get"}},"example":{"id":12345,"group_id":1,"path":"example_path","access":"get"}},"setupNumberList":{"type":"object","properties":{"list_id":{"description":"List Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":1},"phone_number":{"description":"Phone Number","type":"integer","nullable":false,"maxLength":20,"minimum":0,"example":1000000},"meta":{"description":"Meta","type":"string","example":"Sample meta text content"}},"example":{"list_id":1,"phone_number":1000000,"meta":"Sample meta text content"}},"setupNumberListInput":{"type":"object","properties":{"list_id":{"description":"List Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":1},"phone_number":{"description":"Phone Number","type":"integer","nullable":false,"maxLength":20,"minimum":0,"example":1000000},"meta":{"description":"Meta","type":"string","example":"Sample meta text content"}},"example":{"list_id":1,"phone_number":1000000,"meta":"Sample meta text content"},"required":["list_id","phone_number"]},"setupTranscriptionClassificationPolicyCondition":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"default":"uuid()","example":12345},"policy_id":{"description":"Policy Id","type":"string","nullable":false,"example":1},"classifier_id":{"description":"Classifier Id","type":"string","nullable":false,"example":1},"question_id":{"description":"Question Id","type":"string","nullable":false,"example":1},"operator":{"description":"Operator","type":"string","enum":[">=","<="],"nullable":false,"default":">=","example":">="},"threshold":{"description":"Threshold","type":"number","nullable":false,"maxLength":6,"example":99.99},"options":{"description":"Options","type":"object","additionalProperties":true,"example":"Sample options text content"},"sort_order":{"description":"Sort Order","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"0","example":100},"created_at":{"description":"Created At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"updated_at":{"description":"Updated At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"}},"example":{"id":12345,"policy_id":1,"classifier_id":1,"question_id":1,"operator":">=","threshold":99.99,"options":"Sample options text content","sort_order":100,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"}},"setupTranscriptionClassificationPolicyConditionInput":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"default":"uuid()","example":12345},"policy_id":{"description":"Policy Id","type":"string","nullable":false,"example":1},"classifier_id":{"description":"Classifier Id","type":"string","nullable":false,"example":1},"question_id":{"description":"Question Id","type":"string","nullable":false,"example":1},"operator":{"description":"Operator","type":"string","enum":[">=","<="],"nullable":false,"default":">=","example":">="},"threshold":{"description":"Threshold","type":"number","nullable":false,"maxLength":6,"example":99.99},"options":{"description":"Options","type":"object","additionalProperties":true,"example":"Sample options text content"},"sort_order":{"description":"Sort Order","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"0","example":100},"created_at":{"description":"Created At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"updated_at":{"description":"Updated At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"}},"example":{"id":12345,"policy_id":1,"classifier_id":1,"question_id":1,"operator":">=","threshold":99.99,"options":"Sample options text content","sort_order":100,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"},"required":["policy_id","classifier_id","question_id","operator","threshold","sort_order"]},"setupTranscriptionClassifierQuestion":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"default":"uuid()","example":12345},"classifier_id":{"description":"Classifier Id (references transcription_classifier.id)","type":"string","nullable":false,"x-foreignKey":{"referencesTable":"transcription_classifier","referencesColumn":"id"},"example":1},"question_key":{"description":"Question Key","type":"string","nullable":false,"maxLength":64,"example":"example_question_key"},"label":{"description":"Label","type":"string","nullable":false,"maxLength":128,"example":"example_label"},"type":{"description":"Type","type":"string","enum":["noul","choice","score"],"nullable":false,"example":"noul"},"instructions":{"description":"Instructions","type":"string","nullable":false,"maxLength":1000,"example":"example_instructions"},"criteria":{"description":"Criteria","type":"object","additionalProperties":true,"example":"Sample criteria text content"},"sort_order":{"description":"Sort Order","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"0","example":100},"enabled":{"description":"Enabled","type":"integer","nullable":false,"maxLength":1,"default":"1","example":true},"created_at":{"description":"Created At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"updated_at":{"description":"Updated At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"}},"example":{"id":12345,"classifier_id":1,"question_key":"example_question_key","label":"example_label","type":"noul","instructions":"example_instructions","criteria":"Sample criteria text content","sort_order":100,"enabled":true,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"}},"setupTranscriptionClassifierQuestionInput":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"default":"uuid()","example":12345},"classifier_id":{"description":"Classifier Id (references transcription_classifier.id)","type":"string","nullable":false,"x-foreignKey":{"referencesTable":"transcription_classifier","referencesColumn":"id"},"example":1},"question_key":{"description":"Question Key","type":"string","nullable":false,"maxLength":64,"example":"example_question_key"},"label":{"description":"Label","type":"string","nullable":false,"maxLength":128,"example":"example_label"},"type":{"description":"Type","type":"string","enum":["noul","choice","score"],"nullable":false,"example":"noul"},"instructions":{"description":"Instructions","type":"string","nullable":false,"maxLength":1000,"example":"example_instructions"},"criteria":{"description":"Criteria","type":"object","additionalProperties":true,"example":"Sample criteria text content"},"sort_order":{"description":"Sort Order","type":"integer","nullable":false,"maxLength":5,"minimum":0,"default":"0","example":100},"enabled":{"description":"Enabled","type":"integer","nullable":false,"maxLength":1,"default":"1","example":true},"created_at":{"description":"Created At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"updated_at":{"description":"Updated At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"}},"example":{"id":12345,"classifier_id":1,"question_key":"example_question_key","label":"example_label","type":"noul","instructions":"example_instructions","criteria":"Sample criteria text content","sort_order":100,"enabled":true,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"},"required":["classifier_id","question_key","label","type","instructions","sort_order","enabled"]},"setupVars":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":255,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":11,"example":1},"app_id":{"description":"App Id (references app.id)","type":"string","nullable":false,"maxLength":40,"x-foreignKey":{"referencesTable":"app","referencesColumn":"id"},"example":1},"key":{"description":"Key","type":"string","maxLength":255,"example":"example_key"},"value":{"description":"Value","type":"string","example":"Sample value text content"},"key_name":{"description":"Key Name","type":"string","maxLength":100,"example":"example_key_name"},"last_update":{"description":"Last Update","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"flags":{"description":"Flags","type":"array","items":{"type":"string","enum":["protected","private","locked","default"]},"default":"","example":"protected"}},"example":{"id":12345,"account_id":1,"app_id":1,"key":"example_key","value":"Sample value text content","key_name":"example_key_name","last_update":"2025-01-17T10:30:00Z","flags":"protected"}},"setupVarsInput":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":255,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":11,"example":1},"app_id":{"description":"App Id (references app.id)","type":"string","nullable":false,"maxLength":40,"x-foreignKey":{"referencesTable":"app","referencesColumn":"id"},"example":1},"key":{"description":"Key","type":"string","maxLength":255,"example":"example_key"},"value":{"description":"Value","type":"string","example":"Sample value text content"},"key_name":{"description":"Key Name","type":"string","maxLength":100,"example":"example_key_name"},"last_update":{"description":"Last Update","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"flags":{"description":"Flags","type":"array","items":{"type":"string","enum":["protected","private","locked","default"]},"default":"","example":"protected"}},"example":{"id":12345,"account_id":1,"app_id":1,"key":"example_key","value":"Sample value text content","key_name":"example_key_name","last_update":"2025-01-17T10:30:00Z","flags":"protected"},"required":["app_id"]},"class5AiAgentTask":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":40,"default":"uuid()","example":12345},"ai_agent":{"description":"Ai Agent","type":"string","nullable":false,"maxLength":40,"example":"example_ai_agent"},"ai_agent_task_id":{"description":"Ai Agent Task Id","type":"string","nullable":false,"maxLength":40,"example":1},"next_ai_agent_task_id":{"description":"Next Ai Agent Task Id","type":"string","nullable":false,"maxLength":40,"example":1},"condition":{"description":"Condition","type":"string","maxLength":3000,"example":"example_condition"}},"example":{"id":12345,"ai_agent":"example_ai_agent","ai_agent_task_id":1,"next_ai_agent_task_id":1,"condition":"example_condition"}},"class5AiAgentTaskInput":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":40,"default":"uuid()","example":12345},"ai_agent":{"description":"Ai Agent","type":"string","nullable":false,"maxLength":40,"example":"example_ai_agent"},"ai_agent_task_id":{"description":"Ai Agent Task Id","type":"string","nullable":false,"maxLength":40,"example":1},"next_ai_agent_task_id":{"description":"Next Ai Agent Task Id","type":"string","nullable":false,"maxLength":40,"example":1},"condition":{"description":"Condition","type":"string","maxLength":3000,"example":"example_condition"}},"example":{"id":12345,"ai_agent":"example_ai_agent","ai_agent_task_id":1,"next_ai_agent_task_id":1,"condition":"example_condition"},"required":["ai_agent","ai_agent_task_id","next_ai_agent_task_id"]},"class5CallCenterConsumer":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":36,"default":"","example":12345},"call_center_id":{"description":"Call Center Id (references c5_call_center.id)","type":"string","maxLength":36,"x-foreignKey":{"referencesTable":"c5_call_center","referencesColumn":"id"},"example":1},"sip_user_id":{"description":"Sip User Id","type":"integer","maxLength":10,"minimum":0,"example":1},"level":{"description":"Level","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"1","example":123},"position":{"description":"Position","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"1","example":123},"type":{"description":"Type","type":"string","enum":["callback","uuid-standby"],"nullable":false,"default":"callback","example":"callback"},"status":{"description":"Status","type":"string","enum":["Available","Available (On Demand"],"example":"Available"},"max_no_answer":{"description":"Max No Answer","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":123},"wrap_up_time":{"description":"Wrap Up Time","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":123},"reject_delay_time":{"description":"Reject Delay Time","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":123},"busy_delay_time":{"description":"Busy Delay Time","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":123},"no_answer_delay_time":{"description":"No Answer Delay Time","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":123},"ring_timeout":{"description":"Ring Timeout","type":"integer","maxLength":10,"minimum":0,"default":"30","example":123},"created_at":{"description":"Created At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"updated_at":{"description":"Updated At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"}},"example":{"id":12345,"call_center_id":1,"sip_user_id":1,"level":123,"position":123,"type":"callback","status":"Available","max_no_answer":123,"wrap_up_time":123,"reject_delay_time":123,"busy_delay_time":123,"no_answer_delay_time":123,"ring_timeout":123,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"}},"class5CallCenterConsumerInput":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":36,"default":"","example":12345},"call_center_id":{"description":"Call Center Id (references c5_call_center.id)","type":"string","maxLength":36,"x-foreignKey":{"referencesTable":"c5_call_center","referencesColumn":"id"},"example":1},"sip_user_id":{"description":"Sip User Id","type":"integer","maxLength":10,"minimum":0,"example":1},"level":{"description":"Level","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"1","example":123},"position":{"description":"Position","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"1","example":123},"type":{"description":"Type","type":"string","enum":["callback","uuid-standby"],"nullable":false,"default":"callback","example":"callback"},"status":{"description":"Status","type":"string","enum":["Available","Available (On Demand"],"example":"Available"},"max_no_answer":{"description":"Max No Answer","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":123},"wrap_up_time":{"description":"Wrap Up Time","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":123},"reject_delay_time":{"description":"Reject Delay Time","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":123},"busy_delay_time":{"description":"Busy Delay Time","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":123},"no_answer_delay_time":{"description":"No Answer Delay Time","type":"integer","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":123},"ring_timeout":{"description":"Ring Timeout","type":"integer","maxLength":10,"minimum":0,"default":"30","example":123},"created_at":{"description":"Created At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"updated_at":{"description":"Updated At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"}},"example":{"id":12345,"call_center_id":1,"sip_user_id":1,"level":123,"position":123,"type":"callback","status":"Available","max_no_answer":123,"wrap_up_time":123,"reject_delay_time":123,"busy_delay_time":123,"no_answer_delay_time":123,"ring_timeout":123,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"},"required":["level","position","type","max_no_answer","wrap_up_time","reject_delay_time","busy_delay_time","no_answer_delay_time"]},"class5GroupMember":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"group_id":{"description":"Group Id (references c5_group.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"c5_group","referencesColumn":"id"},"example":1},"destination":{"description":"Destination","type":"string","maxLength":255,"example":"example_destination"},"destination_type":{"description":"Destination Type","type":"string","enum":["external","internal","uri","user"],"example":"external"},"ring_timeout":{"description":"Ring Timeout","type":"integer","maxLength":3,"minimum":0,"example":1},"idx":{"description":"Idx","type":"integer","maxLength":255,"minimum":0,"example":1},"weight":{"description":"Weight","type":"integer","maxLength":3,"minimum":0,"example":1}},"example":{"id":12345,"group_id":1,"destination":"example_destination","destination_type":"external","ring_timeout":1,"idx":1,"weight":1}},"class5GroupMemberInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"group_id":{"description":"Group Id (references c5_group.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"c5_group","referencesColumn":"id"},"example":1},"destination":{"description":"Destination","type":"string","maxLength":255,"example":"example_destination"},"destination_type":{"description":"Destination Type","type":"string","enum":["external","internal","uri","user"],"example":"external"},"ring_timeout":{"description":"Ring Timeout","type":"integer","maxLength":3,"minimum":0,"example":1},"idx":{"description":"Idx","type":"integer","maxLength":255,"minimum":0,"example":1},"weight":{"description":"Weight","type":"integer","maxLength":3,"minimum":0,"example":1}},"example":{"id":12345,"group_id":1,"destination":"example_destination","destination_type":"external","ring_timeout":1,"idx":1,"weight":1},"required":["group_id"]},"developerDomain":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":40,"default":"uuid()","example":12345},"app_id":{"description":"App Id (references app.id)","type":"string","maxLength":40,"x-foreignKey":{"referencesTable":"app","referencesColumn":"id"},"example":1},"domain":{"description":"Domain (unique)","type":"string","maxLength":255,"x-unique":true,"example":"example_domain"},"framework_version":{"description":"Framework Version","type":"string","maxLength":255,"default":"latest","example":"example_framework_version"},"flags":{"description":"Flags","type":"string","nullable":false,"maxLength":255,"example":"example_flags"},"sentry_dsn":{"description":"Sentry Dsn","type":"string","maxLength":255,"example":"example_sentry_dsn"},"platform":{"description":"Platform","type":"string","enum":["page-builder","anvil"],"default":"page-builder","example":"page-builder"}},"example":{"id":12345,"app_id":1,"domain":"example_domain","framework_version":"example_framework_version","flags":"example_flags","sentry_dsn":"example_sentry_dsn","platform":"page-builder"}},"developerDomainInput":{"type":"object","properties":{"id":{"description":"Id","type":"string","nullable":false,"maxLength":40,"default":"uuid()","example":12345},"app_id":{"description":"App Id (references app.id)","type":"string","maxLength":40,"x-foreignKey":{"referencesTable":"app","referencesColumn":"id"},"example":1},"domain":{"description":"Domain (unique)","type":"string","maxLength":255,"x-unique":true,"example":"example_domain"},"framework_version":{"description":"Framework Version","type":"string","maxLength":255,"default":"latest","example":"example_framework_version"},"flags":{"description":"Flags","type":"string","nullable":false,"maxLength":255,"example":"example_flags"},"sentry_dsn":{"description":"Sentry Dsn","type":"string","maxLength":255,"example":"example_sentry_dsn"},"platform":{"description":"Platform","type":"string","enum":["page-builder","anvil"],"default":"page-builder","example":"page-builder"}},"example":{"id":12345,"app_id":1,"domain":"example_domain","framework_version":"example_framework_version","flags":"example_flags","sentry_dsn":"example_sentry_dsn","platform":"page-builder"},"required":["flags"]},"package":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"company_id":{"description":"Company Id","type":"integer","maxLength":10,"minimum":0,"example":1},"package_id":{"description":"Package Id","type":"integer","maxLength":10,"minimum":0,"example":1},"st":{"description":"St","type":"string","format":"date-time","maxLength":6,"example":"2025-01-17T10:30:00Z"},"et":{"description":"Et","type":"string","format":"date-time","maxLength":6,"example":"2025-01-17T10:30:00Z"},"qty":{"description":"Qty","type":"integer","maxLength":11,"example":123},"auto_decrement_credit":{"description":"Auto Decrement Credit","type":"integer","maxLength":255,"minimum":0,"example":1},"balance":{"description":"Balance","type":"number","nullable":false,"maxLength":10,"example":99.99},"minutes":{"description":"Minutes","type":"number","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":99.99},"min_days":{"description":"Min Days","type":"integer","maxLength":10,"minimum":0,"default":"0","example":123}},"example":{"id":12345,"account_id":1,"company_id":1,"package_id":1,"st":"2025-01-17T10:30:00Z","et":"2025-01-17T10:30:00Z","qty":123,"auto_decrement_credit":1,"balance":99.99,"minutes":99.99,"min_days":123}},"packageInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"account_id":{"description":"Account Id","type":"integer","maxLength":10,"minimum":0,"example":1},"company_id":{"description":"Company Id","type":"integer","maxLength":10,"minimum":0,"example":1},"package_id":{"description":"Package Id","type":"integer","maxLength":10,"minimum":0,"example":1},"st":{"description":"St","type":"string","format":"date-time","maxLength":6,"example":"2025-01-17T10:30:00Z"},"et":{"description":"Et","type":"string","format":"date-time","maxLength":6,"example":"2025-01-17T10:30:00Z"},"qty":{"description":"Qty","type":"integer","maxLength":11,"example":123},"auto_decrement_credit":{"description":"Auto Decrement Credit","type":"integer","maxLength":255,"minimum":0,"example":1},"balance":{"description":"Balance","type":"number","nullable":false,"maxLength":10,"example":99.99},"minutes":{"description":"Minutes","type":"number","nullable":false,"maxLength":10,"minimum":0,"default":"0","example":99.99},"min_days":{"description":"Min Days","type":"integer","maxLength":10,"minimum":0,"default":"0","example":123}},"example":{"id":12345,"account_id":1,"company_id":1,"package_id":1,"st":"2025-01-17T10:30:00Z","et":"2025-01-17T10:30:00Z","qty":123,"auto_decrement_credit":1,"balance":99.99,"minutes":99.99,"min_days":123},"required":["balance","minutes"]},"phonebookPhone":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"phonebook_id":{"description":"Phonebook Id","type":"integer","maxLength":10,"minimum":0,"example":1},"label":{"description":"Label","type":"string","maxLength":255,"example":"example_label"},"number":{"description":"Number","type":"string","maxLength":255,"example":"example_number"},"extension":{"description":"Extension","type":"string","maxLength":255,"example":"example_extension"},"primary":{"description":"Primary","type":"string","maxLength":255,"example":"example_primary"}},"example":{"id":12345,"phonebook_id":1,"label":"example_label","number":"example_number","extension":"example_extension","primary":"example_primary"}},"phonebookPhoneInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"phonebook_id":{"description":"Phonebook Id","type":"integer","maxLength":10,"minimum":0,"example":1},"label":{"description":"Label","type":"string","maxLength":255,"example":"example_label"},"number":{"description":"Number","type":"string","maxLength":255,"example":"example_number"},"extension":{"description":"Extension","type":"string","maxLength":255,"example":"example_extension"},"primary":{"description":"Primary","type":"string","maxLength":255,"example":"example_primary"}},"example":{"id":12345,"phonebook_id":1,"label":"example_label","number":"example_number","extension":"example_extension","primary":"example_primary"}},"rule":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":20,"minimum":0,"example":12345},"rev_id":{"description":"Rev Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":1},"prefix":{"description":"Prefix","type":"string","nullable":false,"maxLength":15,"example":"example_prefix"},"name":{"description":"Name","type":"string","maxLength":250,"example":"Example Name"},"cost":{"description":"Cost","type":"number","maxLength":10,"example":99.99},"intra":{"description":"Intra","type":"number","maxLength":10,"example":99.99},"inter":{"description":"Inter","type":"number","maxLength":10,"example":99.99},"peak":{"description":"Peak","type":"number","maxLength":10,"example":99.99},"evening":{"description":"Evening","type":"number","maxLength":10,"example":99.99},"weekend":{"description":"Weekend","type":"number","maxLength":10,"example":99.99},"mcd":{"description":"Mcd","type":"integer","nullable":false,"maxLength":4,"default":"1","example":100},"pulse":{"description":"Pulse","type":"integer","nullable":false,"maxLength":4,"default":"1","example":100},"rate_connect":{"description":"Rate Connect","type":"number","nullable":false,"maxLength":10,"default":"0","example":99.99},"date_live":{"description":"Date Live","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"status":{"description":"Status","type":"string","maxLength":50,"example":"Active"},"lcr_json":{"description":"Lcr Json","type":"string","example":"Sample lcr_json text content"},"cost_lcr":{"description":"Cost Lcr","type":"string","maxLength":500,"example":99.99},"intra_lcr":{"description":"Intra Lcr","type":"string","maxLength":500,"example":"example_intra_lcr"},"inter_lcr":{"description":"Inter Lcr","type":"string","maxLength":500,"example":"example_inter_lcr"},"peak_lcr":{"description":"Peak Lcr","type":"string","maxLength":500,"example":"example_peak_lcr"},"evening_lcr":{"description":"Evening Lcr","type":"string","maxLength":500,"example":"example_evening_lcr"},"weekend_lcr":{"description":"Weekend Lcr","type":"string","maxLength":500,"example":"example_weekend_lcr"}},"example":{"id":12345,"rev_id":1,"prefix":"example_prefix","name":"Example Name","cost":99.99,"intra":99.99,"inter":99.99,"peak":99.99,"evening":99.99,"weekend":99.99,"mcd":100,"pulse":100,"rate_connect":99.99,"date_live":"2025-01-17T10:30:00Z","status":"Active","lcr_json":"Sample lcr_json text content","cost_lcr":99.99,"intra_lcr":"example_intra_lcr","inter_lcr":"example_inter_lcr","peak_lcr":"example_peak_lcr","evening_lcr":"example_evening_lcr","weekend_lcr":"example_weekend_lcr"}},"ruleInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":20,"minimum":0,"example":12345},"rev_id":{"description":"Rev Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":1},"prefix":{"description":"Prefix","type":"string","nullable":false,"maxLength":15,"example":"example_prefix"},"name":{"description":"Name","type":"string","maxLength":250,"example":"Example Name"},"cost":{"description":"Cost","type":"number","maxLength":10,"example":99.99},"intra":{"description":"Intra","type":"number","maxLength":10,"example":99.99},"inter":{"description":"Inter","type":"number","maxLength":10,"example":99.99},"peak":{"description":"Peak","type":"number","maxLength":10,"example":99.99},"evening":{"description":"Evening","type":"number","maxLength":10,"example":99.99},"weekend":{"description":"Weekend","type":"number","maxLength":10,"example":99.99},"mcd":{"description":"Mcd","type":"integer","nullable":false,"maxLength":4,"default":"1","example":100},"pulse":{"description":"Pulse","type":"integer","nullable":false,"maxLength":4,"default":"1","example":100},"rate_connect":{"description":"Rate Connect","type":"number","nullable":false,"maxLength":10,"default":"0","example":99.99},"date_live":{"description":"Date Live","type":"string","format":"date-time","example":"2025-01-17T10:30:00Z"},"status":{"description":"Status","type":"string","maxLength":50,"example":"Active"},"lcr_json":{"description":"Lcr Json","type":"string","example":"Sample lcr_json text content"},"cost_lcr":{"description":"Cost Lcr","type":"string","maxLength":500,"example":99.99},"intra_lcr":{"description":"Intra Lcr","type":"string","maxLength":500,"example":"example_intra_lcr"},"inter_lcr":{"description":"Inter Lcr","type":"string","maxLength":500,"example":"example_inter_lcr"},"peak_lcr":{"description":"Peak Lcr","type":"string","maxLength":500,"example":"example_peak_lcr"},"evening_lcr":{"description":"Evening Lcr","type":"string","maxLength":500,"example":"example_evening_lcr"},"weekend_lcr":{"description":"Weekend Lcr","type":"string","maxLength":500,"example":"example_weekend_lcr"}},"example":{"id":12345,"rev_id":1,"prefix":"example_prefix","name":"Example Name","cost":99.99,"intra":99.99,"inter":99.99,"peak":99.99,"evening":99.99,"weekend":99.99,"mcd":100,"pulse":100,"rate_connect":99.99,"date_live":"2025-01-17T10:30:00Z","status":"Active","lcr_json":"Sample lcr_json text content","cost_lcr":99.99,"intra_lcr":"example_intra_lcr","inter_lcr":"example_inter_lcr","peak_lcr":"example_peak_lcr","evening_lcr":"example_evening_lcr","weekend_lcr":"example_weekend_lcr"},"required":["rev_id","prefix","name","mcd","pulse","rate_connect"]},"sipUserNg911":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"sip_user_id":{"description":"Sip User Id (references sip_user.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"sip_user","referencesColumn":"id"},"example":1},"location_id":{"description":"Location Id (unique)","type":"string","nullable":false,"maxLength":64,"x-unique":true,"example":1},"location_name":{"description":"Location Name","type":"string","maxLength":255,"example":"example_location_name"},"is_default":{"description":"Is Default","type":"integer","nullable":false,"maxLength":1,"minimum":0,"default":"0","example":true},"country":{"description":"Country","type":"string","nullable":false,"maxLength":2,"default":"US","example":"US"},"a1":{"description":"A 1","type":"string","maxLength":100,"example":"example_a1"},"a2":{"description":"A 2","type":"string","maxLength":100,"example":"example_a2"},"a3":{"description":"A 3","type":"string","maxLength":255,"example":"example_a3"},"a4":{"description":"A 4","type":"string","maxLength":100,"example":"example_a4"},"hno":{"description":"Hno","type":"string","maxLength":20,"example":"example_hno"},"hno_prefix":{"description":"Hno Prefix","type":"string","maxLength":10,"example":"example_hno_prefix"},"hno_suffix":{"description":"Hno Suffix","type":"string","maxLength":10,"example":"example_hno_suffix"},"prd":{"description":"Prd","type":"string","maxLength":10,"example":"example_prd"},"rd":{"description":"Rd","type":"string","maxLength":255,"example":"example_rd"},"sts":{"description":"Sts","type":"string","maxLength":50,"example":"example_sts"},"pod":{"description":"Pod","type":"string","maxLength":10,"example":"example_pod"},"prm":{"description":"Prm","type":"string","maxLength":50,"example":"example_prm"},"pom":{"description":"Pom","type":"string","maxLength":50,"example":"example_pom"},"bld":{"description":"Bld","type":"string","maxLength":100,"example":"example_bld"},"unit":{"description":"Unit","type":"string","maxLength":50,"example":"example_unit"},"flr":{"description":"Flr","type":"string","maxLength":10,"example":"example_flr"},"room":{"description":"Room","type":"string","maxLength":50,"example":"example_room"},"seat":{"description":"Seat","type":"string","maxLength":50,"example":"example_seat"},"loc":{"description":"Loc","type":"string","maxLength":255,"example":"example_loc"},"nam":{"description":"Nam","type":"string","maxLength":255,"example":"example_nam"},"lmk":{"description":"Lmk","type":"string","maxLength":255,"example":"example_lmk"},"plc":{"description":"Plc","type":"string","maxLength":100,"example":"example_plc"},"pc":{"description":"Pc","type":"string","maxLength":20,"example":"example_pc"},"pcn":{"description":"Pcn","type":"string","maxLength":100,"example":"example_pcn"},"pobox":{"description":"Pobox","type":"string","maxLength":50,"example":"example_pobox"},"addcode":{"description":"Addcode","type":"string","maxLength":50,"example":"example_addcode"},"latitude":{"description":"Latitude","type":"number","maxLength":10,"example":99.99},"longitude":{"description":"Longitude","type":"number","maxLength":10,"example":99.99},"validated":{"description":"Validated","type":"integer","nullable":false,"maxLength":1,"minimum":0,"default":"0","example":1},"validated_at":{"description":"Validated At","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"validation_error":{"description":"Validation Error","type":"string","maxLength":500,"example":"example_validation_error"},"created_at":{"description":"Created At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"updated_at":{"description":"Updated At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"}},"example":{"id":12345,"sip_user_id":1,"location_id":1,"location_name":"example_location_name","is_default":true,"country":"US","a1":"example_a1","a2":"example_a2","a3":"example_a3","a4":"example_a4","hno":"example_hno","hno_prefix":"example_hno_prefix","hno_suffix":"example_hno_suffix","prd":"example_prd","rd":"example_rd","sts":"example_sts","pod":"example_pod","prm":"example_prm","pom":"example_pom","bld":"example_bld","unit":"example_unit","flr":"example_flr","room":"example_room","seat":"example_seat","loc":"example_loc","nam":"example_nam","lmk":"example_lmk","plc":"example_plc","pc":"example_pc","pcn":"example_pcn","pobox":"example_pobox","addcode":"example_addcode","latitude":99.99,"longitude":99.99,"validated":1,"validated_at":"2025-01-17T10:30:00Z","validation_error":"example_validation_error","created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"}},"sipUserNg911Input":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"sip_user_id":{"description":"Sip User Id (references sip_user.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"sip_user","referencesColumn":"id"},"example":1},"location_id":{"description":"Location Id (unique)","type":"string","nullable":false,"maxLength":64,"x-unique":true,"example":1},"location_name":{"description":"Location Name","type":"string","maxLength":255,"example":"example_location_name"},"is_default":{"description":"Is Default","type":"integer","nullable":false,"maxLength":1,"minimum":0,"default":"0","example":true},"country":{"description":"Country","type":"string","nullable":false,"maxLength":2,"default":"US","example":"US"},"a1":{"description":"A 1","type":"string","maxLength":100,"example":"example_a1"},"a2":{"description":"A 2","type":"string","maxLength":100,"example":"example_a2"},"a3":{"description":"A 3","type":"string","maxLength":255,"example":"example_a3"},"a4":{"description":"A 4","type":"string","maxLength":100,"example":"example_a4"},"hno":{"description":"Hno","type":"string","maxLength":20,"example":"example_hno"},"hno_prefix":{"description":"Hno Prefix","type":"string","maxLength":10,"example":"example_hno_prefix"},"hno_suffix":{"description":"Hno Suffix","type":"string","maxLength":10,"example":"example_hno_suffix"},"prd":{"description":"Prd","type":"string","maxLength":10,"example":"example_prd"},"rd":{"description":"Rd","type":"string","maxLength":255,"example":"example_rd"},"sts":{"description":"Sts","type":"string","maxLength":50,"example":"example_sts"},"pod":{"description":"Pod","type":"string","maxLength":10,"example":"example_pod"},"prm":{"description":"Prm","type":"string","maxLength":50,"example":"example_prm"},"pom":{"description":"Pom","type":"string","maxLength":50,"example":"example_pom"},"bld":{"description":"Bld","type":"string","maxLength":100,"example":"example_bld"},"unit":{"description":"Unit","type":"string","maxLength":50,"example":"example_unit"},"flr":{"description":"Flr","type":"string","maxLength":10,"example":"example_flr"},"room":{"description":"Room","type":"string","maxLength":50,"example":"example_room"},"seat":{"description":"Seat","type":"string","maxLength":50,"example":"example_seat"},"loc":{"description":"Loc","type":"string","maxLength":255,"example":"example_loc"},"nam":{"description":"Nam","type":"string","maxLength":255,"example":"example_nam"},"lmk":{"description":"Lmk","type":"string","maxLength":255,"example":"example_lmk"},"plc":{"description":"Plc","type":"string","maxLength":100,"example":"example_plc"},"pc":{"description":"Pc","type":"string","maxLength":20,"example":"example_pc"},"pcn":{"description":"Pcn","type":"string","maxLength":100,"example":"example_pcn"},"pobox":{"description":"Pobox","type":"string","maxLength":50,"example":"example_pobox"},"addcode":{"description":"Addcode","type":"string","maxLength":50,"example":"example_addcode"},"latitude":{"description":"Latitude","type":"number","maxLength":10,"example":99.99},"longitude":{"description":"Longitude","type":"number","maxLength":10,"example":99.99},"validated":{"description":"Validated","type":"integer","nullable":false,"maxLength":1,"minimum":0,"default":"0","example":1},"validated_at":{"description":"Validated At","type":"string","format":"date-time","nullable":true,"example":"2025-01-17T10:30:00Z"},"validation_error":{"description":"Validation Error","type":"string","maxLength":500,"example":"example_validation_error"},"created_at":{"description":"Created At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"},"updated_at":{"description":"Updated At","type":"string","format":"date-time","nullable":false,"default":"current_timestamp()","example":"2025-01-17T10:30:00Z"}},"example":{"id":12345,"sip_user_id":1,"location_id":1,"location_name":"example_location_name","is_default":true,"country":"US","a1":"example_a1","a2":"example_a2","a3":"example_a3","a4":"example_a4","hno":"example_hno","hno_prefix":"example_hno_prefix","hno_suffix":"example_hno_suffix","prd":"example_prd","rd":"example_rd","sts":"example_sts","pod":"example_pod","prm":"example_prm","pom":"example_pom","bld":"example_bld","unit":"example_unit","flr":"example_flr","room":"example_room","seat":"example_seat","loc":"example_loc","nam":"example_nam","lmk":"example_lmk","plc":"example_plc","pc":"example_pc","pcn":"example_pcn","pobox":"example_pobox","addcode":"example_addcode","latitude":99.99,"longitude":99.99,"validated":1,"validated_at":"2025-01-17T10:30:00Z","validation_error":"example_validation_error","created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"},"required":["sip_user_id","location_id","is_default","country","validated"]},"setupServercert":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"server_id":{"description":"Server Id (references server.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"server","referencesColumn":"id"},"example":1},"cert_id":{"description":"Cert Id (references cert.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"cert","referencesColumn":"id"},"example":1},"type":{"description":"Type","type":"string","enum":["client","server"],"default":"server","example":"client"},"method":{"description":"Method","type":"string","nullable":false,"maxLength":30,"default":"TLSv1_2-","example":"example_method"},"verify_cert":{"description":"Verify Cert","type":"integer","nullable":false,"maxLength":2,"minimum":0,"default":"0","example":1},"require_cert":{"description":"Require Cert","type":"integer","nullable":false,"maxLength":2,"minimum":0,"default":"0","example":1},"cipher_list":{"description":"Cipher List","type":"string","nullable":false,"maxLength":2000,"example":"example_cipher_list"},"ec_curve":{"description":"Ec Curve","type":"string","nullable":false,"maxLength":2000,"example":"example_ec_curve"},"dh_params":{"description":"Dh Params","type":"string","example":"Sample dh_params text content"},"match_sip_domain":{"description":"Match Sip Domain","type":"string","maxLength":255,"example":"example_match_sip_domain"}},"example":{"id":12345,"server_id":1,"cert_id":1,"type":"client","method":"example_method","verify_cert":1,"require_cert":1,"cipher_list":"example_cipher_list","ec_curve":"example_ec_curve","dh_params":"Sample dh_params text content","match_sip_domain":"example_match_sip_domain"}},"setupServercertInput":{"type":"object","properties":{"id":{"description":"Id","type":"integer","nullable":false,"maxLength":10,"minimum":0,"example":12345},"server_id":{"description":"Server Id (references server.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"server","referencesColumn":"id"},"example":1},"cert_id":{"description":"Cert Id (references cert.id)","type":"integer","nullable":false,"maxLength":10,"minimum":0,"x-foreignKey":{"referencesTable":"cert","referencesColumn":"id"},"example":1},"type":{"description":"Type","type":"string","enum":["client","server"],"default":"server","example":"client"},"method":{"description":"Method","type":"string","nullable":false,"maxLength":30,"default":"TLSv1_2-","example":"example_method"},"verify_cert":{"description":"Verify Cert","type":"integer","nullable":false,"maxLength":2,"minimum":0,"default":"0","example":1},"require_cert":{"description":"Require Cert","type":"integer","nullable":false,"maxLength":2,"minimum":0,"default":"0","example":1},"cipher_list":{"description":"Cipher List","type":"string","nullable":false,"maxLength":2000,"example":"example_cipher_list"},"ec_curve":{"description":"Ec Curve","type":"string","nullable":false,"maxLength":2000,"example":"example_ec_curve"},"dh_params":{"description":"Dh Params","type":"string","example":"Sample dh_params text content"},"match_sip_domain":{"description":"Match Sip Domain","type":"string","maxLength":255,"example":"example_match_sip_domain"}},"example":{"id":12345,"server_id":1,"cert_id":1,"type":"client","method":"example_method","verify_cert":1,"require_cert":1,"cipher_list":"example_cipher_list","ec_curve":"example_ec_curve","dh_params":"Sample dh_params text content","match_sip_domain":"example_match_sip_domain"},"required":["server_id","cert_id","method","verify_cert","require_cert","cipher_list","ec_curve"]},"jobsNew":{"type":"object","properties":{"queue":{"description":"Queue","type":"string","example":"Sample queue text content"},"id":{"description":"Id","type":"string","example":12345},"seq":{"description":"Seq","type":"integer","example":1000000},"name":{"description":"Name","type":"string","example":"Example Name"},"state":{"description":"State","type":"user-defined","example":"example_state"},"data":{"description":"Data","type":"jsonb","example":"example_data"},"opts":{"description":"Opts","type":"jsonb","example":"example_opts"},"priority":{"description":"Priority","type":"integer","example":"example_priority"},"delay_ms":{"description":"Delay Ms","type":"integer","example":1000000},"max_attempts":{"description":"Max Attempts","type":"integer","example":"example_max_attempts"},"attempts_made":{"description":"Attempts Made","type":"integer","example":"example_attempts_made"},"attempts_started":{"description":"Attempts Started","type":"integer","example":"example_attempts_started"},"progress":{"description":"Progress","type":"jsonb","example":"example_progress"},"return_value":{"description":"Return Value","type":"jsonb","example":"example_return_value"},"failed_reason":{"description":"Failed Reason","type":"string","example":"Sample failed_reason text content"},"stacktrace":{"description":"Stacktrace","type":"jsonb","example":"example_stacktrace"},"deferred_failure":{"description":"Deferred Failure","type":"string","example":"Sample deferred_failure text content"},"processed_by":{"description":"Processed By","type":"string","example":"Sample processed_by text content"},"added_at_ms":{"description":"Added At Ms","type":"integer","example":1000000},"process_at_ms":{"description":"Process At Ms","type":"integer","example":1000000},"processed_at_ms":{"description":"Processed At Ms","type":"integer","example":1000000},"finished_at_ms":{"description":"Finished At Ms","type":"integer","example":1000000},"lock_token":{"description":"Lock Token","type":"string","example":"Sample lock_token text content"},"locked_until_ms":{"description":"Locked Until Ms","type":"integer","example":1000000},"stalled_count":{"description":"Stalled Count","type":"integer","example":10},"dedup_id":{"description":"Dedup Id","type":"string","example":1},"scheduler_id":{"description":"Scheduler Id","type":"string","example":1},"parent_queue":{"description":"Parent Queue","type":"string","example":"Sample parent_queue text content"},"parent_id":{"description":"Parent Id","type":"string","example":1},"parent_key":{"description":"Parent Key","type":"string","example":"Sample parent_key text content"},"pending_deps":{"description":"Pending Deps","type":"integer","example":"example_pending_deps"},"stalled_marked":{"description":"Stalled Marked","type":"boolean","example":"example_stalled_marked"}},"example":{"queue":"Sample queue text content","id":12345,"seq":1000000,"name":"Example Name","state":"example_state","data":"example_data","opts":"example_opts","priority":"example_priority","delay_ms":1000000,"max_attempts":"example_max_attempts","attempts_made":"example_attempts_made","attempts_started":"example_attempts_started","progress":"example_progress","return_value":"example_return_value","failed_reason":"Sample failed_reason text content","stacktrace":"example_stacktrace","deferred_failure":"Sample deferred_failure text content","processed_by":"Sample processed_by text content","added_at_ms":1000000,"process_at_ms":1000000,"processed_at_ms":1000000,"finished_at_ms":1000000,"lock_token":"Sample lock_token text content","locked_until_ms":1000000,"stalled_count":10,"dedup_id":1,"scheduler_id":1,"parent_queue":"Sample parent_queue text content","parent_id":1,"parent_key":"Sample parent_key text content","pending_deps":"example_pending_deps","stalled_marked":"example_stalled_marked"}},"jobsNewInput":{"type":"object","properties":{"queue":{"description":"Queue","type":"string","example":"Sample queue text content"},"id":{"description":"Id","type":"string","example":12345},"seq":{"description":"Seq","type":"integer","example":1000000},"name":{"description":"Name","type":"string","example":"Example Name"},"state":{"description":"State","type":"user-defined","example":"example_state"},"data":{"description":"Data","type":"jsonb","example":"example_data"},"opts":{"description":"Opts","type":"jsonb","example":"example_opts"},"priority":{"description":"Priority","type":"integer","example":"example_priority"},"delay_ms":{"description":"Delay Ms","type":"integer","example":1000000},"max_attempts":{"description":"Max Attempts","type":"integer","example":"example_max_attempts"},"attempts_made":{"description":"Attempts Made","type":"integer","example":"example_attempts_made"},"attempts_started":{"description":"Attempts Started","type":"integer","example":"example_attempts_started"},"progress":{"description":"Progress","type":"jsonb","example":"example_progress"},"return_value":{"description":"Return Value","type":"jsonb","example":"example_return_value"},"failed_reason":{"description":"Failed Reason","type":"string","example":"Sample failed_reason text content"},"stacktrace":{"description":"Stacktrace","type":"jsonb","example":"example_stacktrace"},"deferred_failure":{"description":"Deferred Failure","type":"string","example":"Sample deferred_failure text content"},"processed_by":{"description":"Processed By","type":"string","example":"Sample processed_by text content"},"added_at_ms":{"description":"Added At Ms","type":"integer","example":1000000},"process_at_ms":{"description":"Process At Ms","type":"integer","example":1000000},"processed_at_ms":{"description":"Processed At Ms","type":"integer","example":1000000},"finished_at_ms":{"description":"Finished At Ms","type":"integer","example":1000000},"lock_token":{"description":"Lock Token","type":"string","example":"Sample lock_token text content"},"locked_until_ms":{"description":"Locked Until Ms","type":"integer","example":1000000},"stalled_count":{"description":"Stalled Count","type":"integer","example":10},"dedup_id":{"description":"Dedup Id","type":"string","example":1},"scheduler_id":{"description":"Scheduler Id","type":"string","example":1},"parent_queue":{"description":"Parent Queue","type":"string","example":"Sample parent_queue text content"},"parent_id":{"description":"Parent Id","type":"string","example":1},"parent_key":{"description":"Parent Key","type":"string","example":"Sample parent_key text content"},"pending_deps":{"description":"Pending Deps","type":"integer","example":"example_pending_deps"},"stalled_marked":{"description":"Stalled Marked","type":"boolean","example":"example_stalled_marked"}},"example":{"queue":"Sample queue text content","id":12345,"seq":1000000,"name":"Example Name","state":"example_state","data":"example_data","opts":"example_opts","priority":"example_priority","delay_ms":1000000,"max_attempts":"example_max_attempts","attempts_made":"example_attempts_made","attempts_started":"example_attempts_started","progress":"example_progress","return_value":"example_return_value","failed_reason":"Sample failed_reason text content","stacktrace":"example_stacktrace","deferred_failure":"Sample deferred_failure text content","processed_by":"Sample processed_by text content","added_at_ms":1000000,"process_at_ms":1000000,"processed_at_ms":1000000,"finished_at_ms":1000000,"lock_token":"Sample lock_token text content","locked_until_ms":1000000,"stalled_count":10,"dedup_id":1,"scheduler_id":1,"parent_queue":"Sample parent_queue text content","parent_id":1,"parent_key":"Sample parent_key text content","pending_deps":"example_pending_deps","stalled_marked":"example_stalled_marked"},"required":["name"]},"jobsUserspace":{"type":"object","properties":{"queue":{"description":"Queue","type":"string","example":"Sample queue text content"},"id":{"description":"Id","type":"string","example":12345},"seq":{"description":"Seq","type":"integer","example":1000000},"name":{"description":"Name","type":"string","example":"Example Name"},"state":{"description":"State","type":"user-defined","example":"example_state"},"data":{"description":"Data","type":"jsonb","example":"example_data"},"opts":{"description":"Opts","type":"jsonb","example":"example_opts"},"priority":{"description":"Priority","type":"integer","example":"example_priority"},"delay_ms":{"description":"Delay Ms","type":"integer","example":1000000},"max_attempts":{"description":"Max Attempts","type":"integer","example":"example_max_attempts"},"attempts_made":{"description":"Attempts Made","type":"integer","example":"example_attempts_made"},"attempts_started":{"description":"Attempts Started","type":"integer","example":"example_attempts_started"},"progress":{"description":"Progress","type":"jsonb","example":"example_progress"},"return_value":{"description":"Return Value","type":"jsonb","example":"example_return_value"},"failed_reason":{"description":"Failed Reason","type":"string","example":"Sample failed_reason text content"},"stacktrace":{"description":"Stacktrace","type":"jsonb","example":"example_stacktrace"},"deferred_failure":{"description":"Deferred Failure","type":"string","example":"Sample deferred_failure text content"},"processed_by":{"description":"Processed By","type":"string","example":"Sample processed_by text content"},"added_at_ms":{"description":"Added At Ms","type":"integer","example":1000000},"process_at_ms":{"description":"Process At Ms","type":"integer","example":1000000},"processed_at_ms":{"description":"Processed At Ms","type":"integer","example":1000000},"finished_at_ms":{"description":"Finished At Ms","type":"integer","example":1000000},"lock_token":{"description":"Lock Token","type":"string","example":"Sample lock_token text content"},"locked_until_ms":{"description":"Locked Until Ms","type":"integer","example":1000000},"stalled_count":{"description":"Stalled Count","type":"integer","example":10},"dedup_id":{"description":"Dedup Id","type":"string","example":1},"scheduler_id":{"description":"Scheduler Id","type":"string","example":1},"parent_queue":{"description":"Parent Queue","type":"string","example":"Sample parent_queue text content"},"parent_id":{"description":"Parent Id","type":"string","example":1},"parent_key":{"description":"Parent Key","type":"string","example":"Sample parent_key text content"},"pending_deps":{"description":"Pending Deps","type":"integer","example":"example_pending_deps"},"stalled_marked":{"description":"Stalled Marked","type":"boolean","example":"example_stalled_marked"}},"example":{"queue":"Sample queue text content","id":12345,"seq":1000000,"name":"Example Name","state":"example_state","data":"example_data","opts":"example_opts","priority":"example_priority","delay_ms":1000000,"max_attempts":"example_max_attempts","attempts_made":"example_attempts_made","attempts_started":"example_attempts_started","progress":"example_progress","return_value":"example_return_value","failed_reason":"Sample failed_reason text content","stacktrace":"example_stacktrace","deferred_failure":"Sample deferred_failure text content","processed_by":"Sample processed_by text content","added_at_ms":1000000,"process_at_ms":1000000,"processed_at_ms":1000000,"finished_at_ms":1000000,"lock_token":"Sample lock_token text content","locked_until_ms":1000000,"stalled_count":10,"dedup_id":1,"scheduler_id":1,"parent_queue":"Sample parent_queue text content","parent_id":1,"parent_key":"Sample parent_key text content","pending_deps":"example_pending_deps","stalled_marked":"example_stalled_marked"}},"jobsUserspaceInput":{"type":"object","properties":{"queue":{"description":"Queue","type":"string","example":"Sample queue text content"},"id":{"description":"Id","type":"string","example":12345},"seq":{"description":"Seq","type":"integer","example":1000000},"name":{"description":"Name","type":"string","example":"Example Name"},"state":{"description":"State","type":"user-defined","example":"example_state"},"data":{"description":"Data","type":"jsonb","example":"example_data"},"opts":{"description":"Opts","type":"jsonb","example":"example_opts"},"priority":{"description":"Priority","type":"integer","example":"example_priority"},"delay_ms":{"description":"Delay Ms","type":"integer","example":1000000},"max_attempts":{"description":"Max Attempts","type":"integer","example":"example_max_attempts"},"attempts_made":{"description":"Attempts Made","type":"integer","example":"example_attempts_made"},"attempts_started":{"description":"Attempts Started","type":"integer","example":"example_attempts_started"},"progress":{"description":"Progress","type":"jsonb","example":"example_progress"},"return_value":{"description":"Return Value","type":"jsonb","example":"example_return_value"},"failed_reason":{"description":"Failed Reason","type":"string","example":"Sample failed_reason text content"},"stacktrace":{"description":"Stacktrace","type":"jsonb","example":"example_stacktrace"},"deferred_failure":{"description":"Deferred Failure","type":"string","example":"Sample deferred_failure text content"},"processed_by":{"description":"Processed By","type":"string","example":"Sample processed_by text content"},"added_at_ms":{"description":"Added At Ms","type":"integer","example":1000000},"process_at_ms":{"description":"Process At Ms","type":"integer","example":1000000},"processed_at_ms":{"description":"Processed At Ms","type":"integer","example":1000000},"finished_at_ms":{"description":"Finished At Ms","type":"integer","example":1000000},"lock_token":{"description":"Lock Token","type":"string","example":"Sample lock_token text content"},"locked_until_ms":{"description":"Locked Until Ms","type":"integer","example":1000000},"stalled_count":{"description":"Stalled Count","type":"integer","example":10},"dedup_id":{"description":"Dedup Id","type":"string","example":1},"scheduler_id":{"description":"Scheduler Id","type":"string","example":1},"parent_queue":{"description":"Parent Queue","type":"string","example":"Sample parent_queue text content"},"parent_id":{"description":"Parent Id","type":"string","example":1},"parent_key":{"description":"Parent Key","type":"string","example":"Sample parent_key text content"},"pending_deps":{"description":"Pending Deps","type":"integer","example":"example_pending_deps"},"stalled_marked":{"description":"Stalled Marked","type":"boolean","example":"example_stalled_marked"}},"example":{"queue":"Sample queue text content","id":12345,"seq":1000000,"name":"Example Name","state":"example_state","data":"example_data","opts":"example_opts","priority":"example_priority","delay_ms":1000000,"max_attempts":"example_max_attempts","attempts_made":"example_attempts_made","attempts_started":"example_attempts_started","progress":"example_progress","return_value":"example_return_value","failed_reason":"Sample failed_reason text content","stacktrace":"example_stacktrace","deferred_failure":"Sample deferred_failure text content","processed_by":"Sample processed_by text content","added_at_ms":1000000,"process_at_ms":1000000,"processed_at_ms":1000000,"finished_at_ms":1000000,"lock_token":"Sample lock_token text content","locked_until_ms":1000000,"stalled_count":10,"dedup_id":1,"scheduler_id":1,"parent_queue":"Sample parent_queue text content","parent_id":1,"parent_key":"Sample parent_key text content","pending_deps":"example_pending_deps","stalled_marked":"example_stalled_marked"},"required":["name"]},"transcriptionReport":{"type":"object","properties":{"callid character varying(255)\naccount_id integer\ncustomer_id integer\nclassifier_id uuid\nclassifier_name character varying(128)\nfirst_chunk_at timestamp without time zone\nlast_chunk_at timestamp without time zone\ntranscript_duration_s real\nchunk_count integer\nwords_total integer\nlive_evaluations integer\npeak_scores jsonb\nfinal_status character varying(8)\nfinal_classification_id bigint\nfinal_completed_at timestamp without time zone\nfinal_model character varying(128)\nfinal_scores jsonb\nfts_matches bigint\nsemantic_matches bigint\nsemantic_actions ARRAY\ntags ARRAY\nfirst_semantic_match_offset_s real\nfirst_fts_match_offset_s real\nany_action_executed boolean\nexecuted_actions integer\nfailed_actions integer\npending_actions":{"description":"Callid Character Varying 255 Account Id Integer Customer Id Integer Classifier Id Uuid Classifier Name Character Varying 128 First Chunk At Timestamp Without Time Zone Last Chunk At Timestamp Without Time Zone Transcript Duration S Real Chunk Count Integer Words Total Integer Live Evaluations Integer Peak Scores Jsonb Final Status Character Varying 8 Final Classification Id Bigint Final Completed At Timestamp Without Time Zone Final Model Character Varying 128 Final Scores Jsonb Fts Matches Bigint Semantic Matches Bigint Semantic Actions ARRAY Tags ARRAY First Semantic Match Offset S Real First Fts Match Offset S Real Any Action Executed Boolean Executed Actions Integer Failed Actions Integer Pending Actions","type":"integer","example":10}},"example":{"callid character varying(255)\naccount_id integer\ncustomer_id integer\nclassifier_id uuid\nclassifier_name character varying(128)\nfirst_chunk_at timestamp without time zone\nlast_chunk_at timestamp without time zone\ntranscript_duration_s real\nchunk_count integer\nwords_total integer\nlive_evaluations integer\npeak_scores jsonb\nfinal_status character varying(8)\nfinal_classification_id bigint\nfinal_completed_at timestamp without time zone\nfinal_model character varying(128)\nfinal_scores jsonb\nfts_matches bigint\nsemantic_matches bigint\nsemantic_actions ARRAY\ntags ARRAY\nfirst_semantic_match_offset_s real\nfirst_fts_match_offset_s real\nany_action_executed boolean\nexecuted_actions integer\nfailed_actions integer\npending_actions":10}},"transcribe":{"type":"object","properties":{"id uuid NOT NULL\ncallid character varying(255) NOT NULL\naccount_id integer\ncustomer_id integer\ntext text\nprovider_id integer\nleg character varying(255)\ndt timestamp without":{"description":"Id Uuid NOT NULL Callid Character Varying 255 NOT NULL Account Id Integer Customer Id Integer Text Text Provider Id Integer Leg Character Varying 255 Dt Timestamp Without","type":"string","example":10}},"example":{"id uuid NOT NULL\ncallid character varying(255) NOT NULL\naccount_id integer\ncustomer_id integer\ntext text\nprovider_id integer\nleg character varying(255)\ndt timestamp without":10}},"setupTranscriptionQueryProfile":{"type":"object","properties":{"id character varying(255) NOT NULL\nname character varying(255)\naccount_id bigint\ncompany_id bigint\nquery text\nvisibility character varying(255)\naction":{"description":"Id Character Varying 255 NOT NULL Name Character Varying 255 Account Id Bigint Company Id Bigint Query Text Visibility Character Varying 255 Action","type":"string","example":10}},"example":{"id character varying(255) NOT NULL\nname character varying(255)\naccount_id bigint\ncompany_id bigint\nquery text\nvisibility character varying(255)\naction":10}},"setupTranscriptionQueryProfileInput":{"type":"object","properties":{"id character varying(255) NOT NULL\nname character varying(255)\naccount_id bigint\ncompany_id bigint\nquery text\nvisibility character varying(255)\naction":{"description":"Id Character Varying 255 NOT NULL Name Character Varying 255 Account Id Bigint Company Id Bigint Query Text Visibility Character Varying 255 Action","type":"string","example":10}},"example":{"id character varying(255) NOT NULL\nname character varying(255)\naccount_id bigint\ncompany_id bigint\nquery text\nvisibility character varying(255)\naction":10}},"transcription":{"type":"object","properties":{"callid character varying(255) NOT NULL\naccount_id integer\ncustomer_id integer\nfirst_dt timestamp without time zone\nlast_dt timestamp without time zone\nstart_time real\nend_time real\nchunk_count bigint NOT NULL\ntotal_chunk_duration double precision NOT NULL\ntotal_whisper_time double precision NOT NULL\ntotal_processing_time":{"description":"Callid Character Varying 255 NOT NULL Account Id Integer Customer Id Integer First Dt Timestamp Without Time Zone Last Dt Timestamp Without Time Zone Start Time Real End Time Real Chunk Count Bigint NOT NULL Total Chunk Duration Double Precision NOT NULL Total Whisper Time Double Precision NOT NULL Total Processing Time","type":"number","example":10}},"example":{"callid character varying(255) NOT NULL\naccount_id integer\ncustomer_id integer\nfirst_dt timestamp without time zone\nlast_dt timestamp without time zone\nstart_time real\nend_time real\nchunk_count bigint NOT NULL\ntotal_chunk_duration double precision NOT NULL\ntotal_whisper_time double precision NOT NULL\ntotal_processing_time":10}}}},"paths":{"/api/cp/alert":{"get":{"tags":["Alert"],"summary":"List","description":"Retrieve a paginated list of Alert records. Supports filtering, sorting, and search.","operationId":"alertList","parameters":[{"in":"query","name":"operator","description":"Filter by Operator","required":false,"schema":{"type":"string","enum":["<","<=","=",">",">=","always"]}},{"in":"query","name":"state","description":"Filter by State","required":false,"schema":{"type":"string","enum":["Paused","Ready","Fired","Sent","Simulate"]}},{"in":"query","name":"notice_level","description":"Filter by Notice Level","required":false,"schema":{"type":"string","enum":["none","warning","error"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/alert"}},"example":[{"id":12345,"company_id":1,"title":"Example Name","area":"example_area","operator":"<","threshold":99.99,"reset_threshold":99.99,"sample_period":123,"recipient":"example_recipient","template":"example_template","state":"Paused","penalty":123,"reset_timeout":"2025-01-17T10:30:00Z","cron":"example_cron","sandbox_id":1,"last_ran":"2025-01-17T10:30:00Z","next_run":"2025-01-17T10:30:00Z","tag":"example_tag","notice_level":"none","table_change":"example_table_change","query":"Sample query text content"},{"id":12345,"company_id":1,"title":"Example Name","area":"example_area","operator":"<","threshold":99.99,"reset_threshold":99.99,"sample_period":123,"recipient":"example_recipient","template":"example_template","state":"Paused","penalty":123,"reset_timeout":"2025-01-17T10:30:00Z","cron":"example_cron","sandbox_id":1,"last_ran":"2025-01-17T10:30:00Z","next_run":"2025-01-17T10:30:00Z","tag":"example_tag","notice_level":"none","table_change":"example_table_change","query":"Sample query text content"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Alert"],"summary":"Create","description":"Create a new Alert record.","operationId":"alertCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/alertInput"},"example":{"company_id":1,"title":"Example Name","area":"example_area","operator":"<","threshold":99.99,"reset_threshold":99.99,"sample_period":123,"recipient":"example_recipient","template":"example_template","state":"Paused","penalty":123,"reset_timeout":"2025-01-17T10:30:00Z","cron":"example_cron","sandbox_id":1,"last_ran":"2025-01-17T10:30:00Z","next_run":"2025-01-17T10:30:00Z","tag":"example_tag","notice_level":"none","table_change":"example_table_change","query":"Sample query text content"}}}}}},"/api/cp/alert-global":{"get":{"tags":["Alert Global"],"summary":"List","description":"Retrieve a paginated list of Alert Global records. Supports filtering, sorting, and search.","operationId":"alertGlobalList","parameters":[{"in":"query","name":"operator","description":"Filter by Operator","required":false,"schema":{"type":"string","enum":["<","<=","=",">",">=","always"]}},{"in":"query","name":"notice_level","description":"Filter by Notice Level","required":false,"schema":{"type":"string","enum":["none","warning","error"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/alertGlobal"}},"example":[{"id":12345,"account_id":1,"title":"Example Name","area":"example_area","operator":"<","threshold":99.99,"reset_threshold":99.99,"sample_period":123,"template":"example_template","penalty":123,"cron":"example_cron","sandbox_id":1,"last_ran":"2025-01-17T10:30:00Z","next_run":"2025-01-17T10:30:00Z","tag":"example_tag","notice_level":"none","table_change":"example_table_change","query":"Sample query text content"},{"id":12345,"account_id":1,"title":"Example Name","area":"example_area","operator":"<","threshold":99.99,"reset_threshold":99.99,"sample_period":123,"template":"example_template","penalty":123,"cron":"example_cron","sandbox_id":1,"last_ran":"2025-01-17T10:30:00Z","next_run":"2025-01-17T10:30:00Z","tag":"example_tag","notice_level":"none","table_change":"example_table_change","query":"Sample query text content"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Alert Global"],"summary":"Create","description":"Create a new Alert Global record.","operationId":"alertGlobalCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/alertGlobalInput"},"example":{"account_id":1,"title":"Example Name","area":"example_area","operator":"<","threshold":99.99,"reset_threshold":99.99,"sample_period":123,"template":"example_template","penalty":123,"cron":"example_cron","sandbox_id":1,"last_ran":"2025-01-17T10:30:00Z","next_run":"2025-01-17T10:30:00Z","tag":"example_tag","notice_level":"none","table_change":"example_table_change","query":"Sample query text content"}}}}}},"/api/cp/alert-global/{id}":{"get":{"tags":["Alert Global"],"summary":"Read","description":"Retrieve a single Alert Global record by ID.","operationId":"alertGlobalRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/alertGlobal"},"example":{"id":12345,"account_id":1,"title":"Example Name","area":"example_area","operator":"<","threshold":99.99,"reset_threshold":99.99,"sample_period":123,"template":"example_template","penalty":123,"cron":"example_cron","sandbox_id":1,"last_ran":"2025-01-17T10:30:00Z","next_run":"2025-01-17T10:30:00Z","tag":"example_tag","notice_level":"none","table_change":"example_table_change","query":"Sample query text content"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Alert Global"],"summary":"Update","description":"Update an existing Alert Global record by ID.","operationId":"alertGlobalUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/alertGlobalInput"},"example":{"account_id":1,"title":"Example Name","area":"example_area","operator":"<","threshold":99.99,"reset_threshold":99.99,"sample_period":123,"template":"example_template","penalty":123,"cron":"example_cron","sandbox_id":1,"last_ran":"2025-01-17T10:30:00Z","next_run":"2025-01-17T10:30:00Z","tag":"example_tag","notice_level":"none","table_change":"example_table_change","query":"Sample query text content"}}}}},"delete":{"tags":["Alert Global"],"summary":"Delete","description":"Delete a Alert Global record by ID.","operationId":"alertGlobalDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/alert/{id}":{"get":{"tags":["Alert"],"summary":"Read","description":"Retrieve a single Alert record by ID.","operationId":"alertRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/alert"},"example":{"id":12345,"company_id":1,"title":"Example Name","area":"example_area","operator":"<","threshold":99.99,"reset_threshold":99.99,"sample_period":123,"recipient":"example_recipient","template":"example_template","state":"Paused","penalty":123,"reset_timeout":"2025-01-17T10:30:00Z","cron":"example_cron","sandbox_id":1,"last_ran":"2025-01-17T10:30:00Z","next_run":"2025-01-17T10:30:00Z","tag":"example_tag","notice_level":"none","table_change":"example_table_change","query":"Sample query text content"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Alert"],"summary":"Update","description":"Update an existing Alert record by ID.","operationId":"alertUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/alertInput"},"example":{"company_id":1,"title":"Example Name","area":"example_area","operator":"<","threshold":99.99,"reset_threshold":99.99,"sample_period":123,"recipient":"example_recipient","template":"example_template","state":"Paused","penalty":123,"reset_timeout":"2025-01-17T10:30:00Z","cron":"example_cron","sandbox_id":1,"last_ran":"2025-01-17T10:30:00Z","next_run":"2025-01-17T10:30:00Z","tag":"example_tag","notice_level":"none","table_change":"example_table_change","query":"Sample query text content"}}}}},"delete":{"tags":["Alert"],"summary":"Delete","description":"Delete a Alert record by ID.","operationId":"alertDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/alias":{"get":{"tags":["Alias"],"summary":"List","description":"Retrieve a paginated list of Alias records. Supports filtering, sorting, and search.","operationId":"aliasList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/alias"}},"example":[{"id":12345,"company_id":1,"current":"example_current","new":"example_new"},{"id":12345,"company_id":1,"current":"example_current","new":"example_new"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Alias"],"summary":"Create","description":"Create a new Alias record.","operationId":"aliasCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aliasInput"},"example":{"company_id":1,"current":"example_current","new":"example_new"}}}}}},"/api/cp/alias/{id}":{"get":{"tags":["Alias"],"summary":"Read","description":"Retrieve a single Alias record by ID.","operationId":"aliasRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/alias"},"example":{"id":12345,"company_id":1,"current":"example_current","new":"example_new"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Alias"],"summary":"Update","description":"Update an existing Alias record by ID.","operationId":"aliasUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aliasInput"},"example":{"company_id":1,"current":"example_current","new":"example_new"}}}}},"delete":{"tags":["Alias"],"summary":"Delete","description":"Delete a Alias record by ID.","operationId":"aliasDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/analytics":{"post":{"tags":["Analytics"],"summary":"Query","description":"Query","operationId":"analyticsQuery","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/analytics/rtp":{"post":{"tags":["Analytics"],"summary":"RTP Query","description":"RTP Query","operationId":"analyticsRtpQuery","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/auth/authorize":{"get":{"tags":["Auth"],"summary":"OAuth Authorize","description":"OAuth Authorize","operationId":"authOAuthAuthorize","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false}},"/api/cp/auth/callback":{"get":{"tags":["Auth"],"summary":"OAuth Callback","description":"OAuth Callback","operationId":"authOAuthCallback","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false}},"/api/cp/auth/forgot":{"post":{"tags":["Auth"],"summary":"Forgot Password","description":"Forgot Password","operationId":"authForgotPassword","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false}},"/api/cp/auth/jwt":{"get":{"tags":["Auth"],"summary":"Generate JWT","description":"Generate JWT","operationId":"authGenerateJwt","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false}},"/api/cp/auth/jwt/refresh":{"post":{"tags":["Auth"],"summary":"Generate JWT Refresh","description":"Generate JWT Refresh","operationId":"authGenerateJwtRefresh","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false}},"/api/cp/auth/logout":{"get":{"tags":["Auth"],"summary":"Logout","description":"Logout","operationId":"authLogout","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Auth"],"summary":"Logout (POST)","description":"Logout (POST)","operationId":"authLogoutPost","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/auth/passkey":{"get":{"tags":["Auth"],"summary":"Pass Key","description":"Pass Key","operationId":"authPassKey","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/auth/register":{"post":{"tags":["Auth"],"summary":"Register","description":"Register","operationId":"authRegister","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false}},"/api/cp/auth/verify-email":{"get":{"tags":["Auth"],"summary":"Verify Email","description":"Verify Email","operationId":"authVerifyEmail","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false}},"/api/cp/breakout":{"post":{"tags":["Breakout"],"summary":"Query","description":"Query","operationId":"breakoutQuery","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"requestBody":{"description":"Request Body Description","content":{"application/json":{"schema":{"example":{"limit":100000,"where":{"operator":"AND","rules":[{"field":"dt","condition":">=","data":"2024-02-21 00:00:00"},{"field":"dt","condition":"<","data":"2024-02-21 23:59:59"}]},"group":["customer_id","provider_id","customer_card_dest_name","provider_card_dest_name"],"field":["customer_id","provider_id","customer_card_dest_name","provider_card_dest_name",{"field":"attempts","fn":"sum"},{"field":"connected","fn":"sum"},{"field":"sdp_6","fn":"sum"},{"field":"customer_duration","fn":"sum"},{"field":"provider_duration","fn":"sum"},{"field":"duration","fn":"sum"},{"field":"provider_charge","fn":"sum"},{"field":"customer_charge","fn":"sum"},{"field":"customer_charge_avg","fn":"avg"},{"field":"provider_charge_avg","fn":"avg"},{"field":"provider_currency","fn":"first"},{"field":"customer_currency","fn":"first"},{"fn":"asr"},{"fn":"acd"},{"fn":"dtmf"},{"field":"account_profit","fn":"sum"},{"field":"account_profit_percent","fn":"avg"}]}}}}},"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/button":{"get":{"tags":["Button"],"summary":"List","description":"Retrieve a paginated list of Button records. Supports filtering, sorting, and search.","operationId":"buttonList","parameters":[{"in":"query","name":"type","description":"Filter by Type","required":false,"schema":{"type":"string"}},{"in":"query","name":"open_mode","description":"Filter by Open Mode","required":false,"schema":{"type":"string","enum":["page","dialog"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/button"}},"example":[{"id":12345,"account_id":1,"company_id":1,"app_id":1,"anvil_path":"example_anvil_path","label":"example_label","icon":"example_icon","tooltip":"example_tooltip","type":"example_type","area":"example_area","placement":"example_placement","min_select":123,"max_select":123,"sandbox_id":1,"fn":"example_fn","form_id":1,"page_id":1,"sort_order":1,"company_ids":"example_company_ids","open_mode":"page"},{"id":12345,"account_id":1,"company_id":1,"app_id":1,"anvil_path":"example_anvil_path","label":"example_label","icon":"example_icon","tooltip":"example_tooltip","type":"example_type","area":"example_area","placement":"example_placement","min_select":123,"max_select":123,"sandbox_id":1,"fn":"example_fn","form_id":1,"page_id":1,"sort_order":1,"company_ids":"example_company_ids","open_mode":"page"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/calling-card":{"get":{"tags":["Calling Card"],"summary":"List","description":"Retrieve a paginated list of Calling Card records. Supports filtering, sorting, and search.","operationId":"callingCardList","parameters":[{"in":"query","name":"status","description":"Filter by Status","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/callingCard"}},"example":[{"id":12345,"account_id":1,"customer_rate_card":"example_customer_rate_card","credit":99.99,"status":"Active","template_customer_id":1,"min_activation":99.99,"multiplier":99.99,"addition":99.99},{"id":12345,"account_id":1,"customer_rate_card":"example_customer_rate_card","credit":99.99,"status":"Active","template_customer_id":1,"min_activation":99.99,"multiplier":99.99,"addition":99.99}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Calling Card"],"summary":"Create","description":"Create a new Calling Card record.","operationId":"callingCardCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/callingCardInput"},"example":{"account_id":1,"customer_rate_card":"example_customer_rate_card","credit":99.99,"status":"Active","template_customer_id":1,"min_activation":99.99,"multiplier":99.99,"addition":99.99}}}}}},"/api/cp/calling-card/{id}":{"get":{"tags":["Calling Card"],"summary":"Read","description":"Retrieve a single Calling Card record by ID.","operationId":"callingCardRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/callingCard"},"example":{"id":12345,"account_id":1,"customer_rate_card":"example_customer_rate_card","credit":99.99,"status":"Active","template_customer_id":1,"min_activation":99.99,"multiplier":99.99,"addition":99.99}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Calling Card"],"summary":"Update","description":"Update an existing Calling Card record by ID.","operationId":"callingCardUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/callingCardInput"},"example":{"account_id":1,"customer_rate_card":"example_customer_rate_card","credit":99.99,"status":"Active","template_customer_id":1,"min_activation":99.99,"multiplier":99.99,"addition":99.99}}}}},"delete":{"tags":["Calling Card"],"summary":"Delete","description":"Delete a Calling Card record by ID.","operationId":"callingCardDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/card":{"get":{"tags":["Card"],"summary":"List","description":"Retrieve a paginated list of Card records. Supports filtering, sorting, and search.","operationId":"cardList","parameters":[{"in":"query","name":"strategy","description":"Filter by Strategy","required":false,"schema":{"type":"string","enum":["LCR","Best ACD","Best ASR","LCR Performance","Random","Reverse LCR","Round Robin"]}},{"in":"query","name":"rounding_method","description":"Filter by Rounding Method","required":false,"schema":{"type":"string","enum":["up","down","half-up","half-down"]}},{"in":"query","name":"duration_rounding_method","description":"Filter by Duration Rounding Method","required":false,"schema":{"type":"string","enum":["up","down","half-up","half-down"]}},{"in":"query","name":"direction","description":"Filter by Direction","required":false,"schema":{"type":"string","enum":["origination","termination"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card"}},"example":[{"id":12345,"account_id":1,"company_id":1,"reseller_id":1,"reseller_ids":"example_reseller_ids","system_id":1,"system_num":123,"name":"Example Name","notes":"Sample notes text content","public_options":"example_public_options","public_name":"example_public_name","public_notes":"Sample public_notes text content","presentation":"example_presentation","collapse":"example_collapse","import_url":"example_import_url","import_map":"example_import_map","import_row_start":123,"import_remove_prefix":1,"import_prepend_prefix":"example_import_prepend_prefix","export_map":"example_export_map","lcr_map":"example_lcr_map","rate_formula":"example_rate_formula","gen_lcr":1,"trust_fail":1,"currency":"USD","tech_prefix":"example_tech_prefix","lrn":1,"override_lcr":"example_override_lcr","connexcs_permission":"example_connexcs_permission","stale":1,"filtered_transform":1,"dyn_routing":"example_dyn_routing","active_rev":true,"cli_restrict":"example_cli_restrict","paid_restrict":"example_paid_restrict","strategy":"LCR","billing_precision":1,"rounding_method":"up","duration_rounding_method":"up","direction":"origination","delayed_bye":1,"delayed_bye_mcd":1,"delayed_bye_charge_customer":1,"sms_url":"example_sms_url","asr_plus":1,"contract_id":1,"default_rtp":1,"force_rtp_id":1,"capped_rate":99.99,"block_connect_cost":99.99,"profit_assurance":99.99,"manual_ordering":1,"channels":123,"cps":123,"block_destination_type":"example_block_destination_type","ptime":123,"origin_billing_source":"example_origin_billing_source","origin_billing_destination":"example_origin_billing_destination"},{"id":12345,"account_id":1,"company_id":1,"reseller_id":1,"reseller_ids":"example_reseller_ids","system_id":1,"system_num":123,"name":"Example Name","notes":"Sample notes text content","public_options":"example_public_options","public_name":"example_public_name","public_notes":"Sample public_notes text content","presentation":"example_presentation","collapse":"example_collapse","import_url":"example_import_url","import_map":"example_import_map","import_row_start":123,"import_remove_prefix":1,"import_prepend_prefix":"example_import_prepend_prefix","export_map":"example_export_map","lcr_map":"example_lcr_map","rate_formula":"example_rate_formula","gen_lcr":1,"trust_fail":1,"currency":"USD","tech_prefix":"example_tech_prefix","lrn":1,"override_lcr":"example_override_lcr","connexcs_permission":"example_connexcs_permission","stale":1,"filtered_transform":1,"dyn_routing":"example_dyn_routing","active_rev":true,"cli_restrict":"example_cli_restrict","paid_restrict":"example_paid_restrict","strategy":"LCR","billing_precision":1,"rounding_method":"up","duration_rounding_method":"up","direction":"origination","delayed_bye":1,"delayed_bye_mcd":1,"delayed_bye_charge_customer":1,"sms_url":"example_sms_url","asr_plus":1,"contract_id":1,"default_rtp":1,"force_rtp_id":1,"capped_rate":99.99,"block_connect_cost":99.99,"profit_assurance":99.99,"manual_ordering":1,"channels":123,"cps":123,"block_destination_type":"example_block_destination_type","ptime":123,"origin_billing_source":"example_origin_billing_source","origin_billing_destination":"example_origin_billing_destination"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Card"],"summary":"Create","description":"Create a new Card record.","operationId":"cardCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cardInput"},"example":{"account_id":1,"company_id":1,"reseller_id":1,"reseller_ids":"example_reseller_ids","system_id":1,"system_num":123,"name":"Example Name","notes":"Sample notes text content","public_options":"example_public_options","public_name":"example_public_name","public_notes":"Sample public_notes text content","presentation":"example_presentation","collapse":"example_collapse","import_url":"example_import_url","import_map":"example_import_map","import_row_start":123,"import_remove_prefix":1,"import_prepend_prefix":"example_import_prepend_prefix","export_map":"example_export_map","lcr_map":"example_lcr_map","rate_formula":"example_rate_formula","gen_lcr":1,"trust_fail":1,"currency":"USD","tech_prefix":"example_tech_prefix","lrn":1,"override_lcr":"example_override_lcr","connexcs_permission":"example_connexcs_permission","stale":1,"filtered_transform":1,"dyn_routing":"example_dyn_routing","active_rev":true,"cli_restrict":"example_cli_restrict","paid_restrict":"example_paid_restrict","strategy":"LCR","billing_precision":1,"rounding_method":"up","duration_rounding_method":"up","direction":"origination","delayed_bye":1,"delayed_bye_mcd":1,"delayed_bye_charge_customer":1,"sms_url":"example_sms_url","asr_plus":1,"contract_id":1,"default_rtp":1,"force_rtp_id":1,"capped_rate":99.99,"block_connect_cost":99.99,"profit_assurance":99.99,"manual_ordering":1,"channels":123,"cps":123,"block_destination_type":"example_block_destination_type","ptime":123,"origin_billing_source":"example_origin_billing_source","origin_billing_destination":"example_origin_billing_destination"}}}}}},"/api/cp/card/{cardId}/rev":{"get":{"tags":["Card Revision"],"summary":"List","description":"Retrieve a paginated list of Card Revision records. Supports filtering, sorting, and search.","operationId":"cardRevisionList","parameters":[{"in":"path","name":"cardId","description":"Card Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"query","name":"rounding_method","description":"Filter by Rounding Method","required":false,"schema":{"type":"string","enum":["up","down","half-up","half-down"]}},{"in":"query","name":"duration_rounding_method","description":"Filter by Duration Rounding Method","required":false,"schema":{"type":"string","enum":["up","down","half-up","half-down"]}},{"in":"query","name":"storage","description":"Filter by Storage","required":false,"schema":{"type":"string","enum":["live","archive","archiving","archiving-deleting","making-live"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/cardRevision"}},"example":[{"id":12345,"card_id":1,"name":"Example Name","ts":"2025-01-17T10:30:00Z","revision":123,"presentation":"example_presentation","external":1,"expire":"2025-01-17T10:30:00Z","stale":1,"currency":"USD","date_live":"2025-01-17T10:30:00Z","count":10,"live_rev_id":1,"billing_precision":1,"rounding_method":"up","duration_rounding_method":"up","origin_billing_source":"example_origin_billing_source","origin_billing_destination":"example_origin_billing_destination","storage":"live","archiving_at":"2025-01-17T10:30:00Z","archive_rule_count":10,"archive_sha256":"example_archive_sha256","archive_size":1000000,"archive_created_at":"2025-01-17T10:30:00Z","archive_deleted_at":"2025-01-17T10:30:00Z","archive_error":"Sample archive_error text content"},{"id":12345,"card_id":1,"name":"Example Name","ts":"2025-01-17T10:30:00Z","revision":123,"presentation":"example_presentation","external":1,"expire":"2025-01-17T10:30:00Z","stale":1,"currency":"USD","date_live":"2025-01-17T10:30:00Z","count":10,"live_rev_id":1,"billing_precision":1,"rounding_method":"up","duration_rounding_method":"up","origin_billing_source":"example_origin_billing_source","origin_billing_destination":"example_origin_billing_destination","storage":"live","archiving_at":"2025-01-17T10:30:00Z","archive_rule_count":10,"archive_sha256":"example_archive_sha256","archive_size":1000000,"archive_created_at":"2025-01-17T10:30:00Z","archive_deleted_at":"2025-01-17T10:30:00Z","archive_error":"Sample archive_error text content"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Card Revision"],"summary":"Create","description":"Create a new Card Revision record.","operationId":"cardRevisionCreate","parameters":[{"in":"path","name":"cardId","description":"Card Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cardRevisionInput"},"example":{"card_id":1,"name":"Example Name","ts":"2025-01-17T10:30:00Z","revision":123,"presentation":"example_presentation","external":1,"expire":"2025-01-17T10:30:00Z","stale":1,"currency":"USD","date_live":"2025-01-17T10:30:00Z","count":10,"live_rev_id":1,"billing_precision":1,"rounding_method":"up","duration_rounding_method":"up","origin_billing_source":"example_origin_billing_source","origin_billing_destination":"example_origin_billing_destination","storage":"live","archiving_at":"2025-01-17T10:30:00Z","archive_rule_count":10,"archive_sha256":"example_archive_sha256","archive_size":1000000,"archive_created_at":"2025-01-17T10:30:00Z","archive_deleted_at":"2025-01-17T10:30:00Z","archive_error":"Sample archive_error text content"}}}}}},"/api/cp/card/{cardId}/rev/{revisionId}":{"get":{"tags":["Card Revision"],"summary":"Read","description":"Retrieve a single Card Revision record by ID.","operationId":"cardRevisionRead","parameters":[{"in":"path","name":"cardId","description":"Card Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"revisionId","description":"Revision Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cardRevision"},"example":{"id":12345,"card_id":1,"name":"Example Name","ts":"2025-01-17T10:30:00Z","revision":123,"presentation":"example_presentation","external":1,"expire":"2025-01-17T10:30:00Z","stale":1,"currency":"USD","date_live":"2025-01-17T10:30:00Z","count":10,"live_rev_id":1,"billing_precision":1,"rounding_method":"up","duration_rounding_method":"up","origin_billing_source":"example_origin_billing_source","origin_billing_destination":"example_origin_billing_destination","storage":"live","archiving_at":"2025-01-17T10:30:00Z","archive_rule_count":10,"archive_sha256":"example_archive_sha256","archive_size":1000000,"archive_created_at":"2025-01-17T10:30:00Z","archive_deleted_at":"2025-01-17T10:30:00Z","archive_error":"Sample archive_error text content"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Card Revision"],"summary":"Update","description":"Update an existing Card Revision record by ID.","operationId":"cardRevisionUpdate","parameters":[{"in":"path","name":"cardId","description":"Card Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"revisionId","description":"Revision Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cardRevisionInput"},"example":{"card_id":1,"name":"Example Name","ts":"2025-01-17T10:30:00Z","revision":123,"presentation":"example_presentation","external":1,"expire":"2025-01-17T10:30:00Z","stale":1,"currency":"USD","date_live":"2025-01-17T10:30:00Z","count":10,"live_rev_id":1,"billing_precision":1,"rounding_method":"up","duration_rounding_method":"up","origin_billing_source":"example_origin_billing_source","origin_billing_destination":"example_origin_billing_destination","storage":"live","archiving_at":"2025-01-17T10:30:00Z","archive_rule_count":10,"archive_sha256":"example_archive_sha256","archive_size":1000000,"archive_created_at":"2025-01-17T10:30:00Z","archive_deleted_at":"2025-01-17T10:30:00Z","archive_error":"Sample archive_error text content"}}}}},"delete":{"tags":["Card Revision"],"summary":"Delete","description":"Delete a Card Revision record by ID.","operationId":"cardRevisionDelete","parameters":[{"in":"path","name":"cardId","description":"Card Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"revisionId","description":"Revision Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/card/{cardId}/rev/{revisionId}/cost-collate":{"get":{"tags":["Card Revision"],"summary":"Cost Collate","description":"Cost Collate","operationId":"cardRevisionCostCollate","parameters":[{"in":"path","name":"cardId","description":"Card Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"revisionId","description":"Revision Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cardRevision"},"example":{"id":12345,"card_id":1,"name":"Example Name","ts":"2025-01-17T10:30:00Z","revision":123,"presentation":"example_presentation","external":1,"expire":"2025-01-17T10:30:00Z","stale":1,"currency":"USD","date_live":"2025-01-17T10:30:00Z","count":10,"live_rev_id":1,"billing_precision":1,"rounding_method":"up","duration_rounding_method":"up","origin_billing_source":"example_origin_billing_source","origin_billing_destination":"example_origin_billing_destination","storage":"live","archiving_at":"2025-01-17T10:30:00Z","archive_rule_count":10,"archive_sha256":"example_archive_sha256","archive_size":1000000,"archive_created_at":"2025-01-17T10:30:00Z","archive_deleted_at":"2025-01-17T10:30:00Z","archive_error":"Sample archive_error text content"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/card/{cardId}/rev/{revisionId}/send":{"post":{"tags":["Card Revision"],"summary":"Send","description":"Send","operationId":"cardRevisionSend","parameters":[{"in":"path","name":"cardId","description":"Card Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"revisionId","description":"Revision Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cardRevisionInput"},"example":{"card_id":1,"name":"Example Name","ts":"2025-01-17T10:30:00Z","revision":123,"presentation":"example_presentation","external":1,"expire":"2025-01-17T10:30:00Z","stale":1,"currency":"USD","date_live":"2025-01-17T10:30:00Z","count":10,"live_rev_id":1,"billing_precision":1,"rounding_method":"up","duration_rounding_method":"up","origin_billing_source":"example_origin_billing_source","origin_billing_destination":"example_origin_billing_destination","storage":"live","archiving_at":"2025-01-17T10:30:00Z","archive_rule_count":10,"archive_sha256":"example_archive_sha256","archive_size":1000000,"archive_created_at":"2025-01-17T10:30:00Z","archive_deleted_at":"2025-01-17T10:30:00Z","archive_error":"Sample archive_error text content"}}}}}},"/api/cp/card/{id}":{"get":{"tags":["Card"],"summary":"Read","description":"Retrieve a single Card record by ID.","operationId":"cardRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card"},"example":{"id":12345,"account_id":1,"company_id":1,"reseller_id":1,"reseller_ids":"example_reseller_ids","system_id":1,"system_num":123,"name":"Example Name","notes":"Sample notes text content","public_options":"example_public_options","public_name":"example_public_name","public_notes":"Sample public_notes text content","presentation":"example_presentation","collapse":"example_collapse","import_url":"example_import_url","import_map":"example_import_map","import_row_start":123,"import_remove_prefix":1,"import_prepend_prefix":"example_import_prepend_prefix","export_map":"example_export_map","lcr_map":"example_lcr_map","rate_formula":"example_rate_formula","gen_lcr":1,"trust_fail":1,"currency":"USD","tech_prefix":"example_tech_prefix","lrn":1,"override_lcr":"example_override_lcr","connexcs_permission":"example_connexcs_permission","stale":1,"filtered_transform":1,"dyn_routing":"example_dyn_routing","active_rev":true,"cli_restrict":"example_cli_restrict","paid_restrict":"example_paid_restrict","strategy":"LCR","billing_precision":1,"rounding_method":"up","duration_rounding_method":"up","direction":"origination","delayed_bye":1,"delayed_bye_mcd":1,"delayed_bye_charge_customer":1,"sms_url":"example_sms_url","asr_plus":1,"contract_id":1,"default_rtp":1,"force_rtp_id":1,"capped_rate":99.99,"block_connect_cost":99.99,"profit_assurance":99.99,"manual_ordering":1,"channels":123,"cps":123,"block_destination_type":"example_block_destination_type","ptime":123,"origin_billing_source":"example_origin_billing_source","origin_billing_destination":"example_origin_billing_destination"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Card"],"summary":"Update","description":"Update an existing Card record by ID.","operationId":"cardUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cardInput"},"example":{"account_id":1,"company_id":1,"reseller_id":1,"reseller_ids":"example_reseller_ids","system_id":1,"system_num":123,"name":"Example Name","notes":"Sample notes text content","public_options":"example_public_options","public_name":"example_public_name","public_notes":"Sample public_notes text content","presentation":"example_presentation","collapse":"example_collapse","import_url":"example_import_url","import_map":"example_import_map","import_row_start":123,"import_remove_prefix":1,"import_prepend_prefix":"example_import_prepend_prefix","export_map":"example_export_map","lcr_map":"example_lcr_map","rate_formula":"example_rate_formula","gen_lcr":1,"trust_fail":1,"currency":"USD","tech_prefix":"example_tech_prefix","lrn":1,"override_lcr":"example_override_lcr","connexcs_permission":"example_connexcs_permission","stale":1,"filtered_transform":1,"dyn_routing":"example_dyn_routing","active_rev":true,"cli_restrict":"example_cli_restrict","paid_restrict":"example_paid_restrict","strategy":"LCR","billing_precision":1,"rounding_method":"up","duration_rounding_method":"up","direction":"origination","delayed_bye":1,"delayed_bye_mcd":1,"delayed_bye_charge_customer":1,"sms_url":"example_sms_url","asr_plus":1,"contract_id":1,"default_rtp":1,"force_rtp_id":1,"capped_rate":99.99,"block_connect_cost":99.99,"profit_assurance":99.99,"manual_ordering":1,"channels":123,"cps":123,"block_destination_type":"example_block_destination_type","ptime":123,"origin_billing_source":"example_origin_billing_source","origin_billing_destination":"example_origin_billing_destination"}}}}},"delete":{"tags":["Card"],"summary":"Delete","description":"Delete a Card record by ID.","operationId":"cardDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/card/{id}/merge_transform":{"post":{"tags":["Card"],"summary":"Merge Transform","description":"Merge Transform","operationId":"cardMergeTransform","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cardInput"},"example":{"account_id":1,"company_id":1,"reseller_id":1,"reseller_ids":"example_reseller_ids","system_id":1,"system_num":123,"name":"Example Name","notes":"Sample notes text content","public_options":"example_public_options","public_name":"example_public_name","public_notes":"Sample public_notes text content","presentation":"example_presentation","collapse":"example_collapse","import_url":"example_import_url","import_map":"example_import_map","import_row_start":123,"import_remove_prefix":1,"import_prepend_prefix":"example_import_prepend_prefix","export_map":"example_export_map","lcr_map":"example_lcr_map","rate_formula":"example_rate_formula","gen_lcr":1,"trust_fail":1,"currency":"USD","tech_prefix":"example_tech_prefix","lrn":1,"override_lcr":"example_override_lcr","connexcs_permission":"example_connexcs_permission","stale":1,"filtered_transform":1,"dyn_routing":"example_dyn_routing","active_rev":true,"cli_restrict":"example_cli_restrict","paid_restrict":"example_paid_restrict","strategy":"LCR","billing_precision":1,"rounding_method":"up","duration_rounding_method":"up","direction":"origination","delayed_bye":1,"delayed_bye_mcd":1,"delayed_bye_charge_customer":1,"sms_url":"example_sms_url","asr_plus":1,"contract_id":1,"default_rtp":1,"force_rtp_id":1,"capped_rate":99.99,"block_connect_cost":99.99,"profit_assurance":99.99,"manual_ordering":1,"channels":123,"cps":123,"block_destination_type":"example_block_destination_type","ptime":123,"origin_billing_source":"example_origin_billing_source","origin_billing_destination":"example_origin_billing_destination"}}}}}},"/api/cp/carrier":{"get":{"tags":["Carrier"],"summary":"List","description":"Retrieve a paginated list of Carrier records. Supports filtering, sorting, and search.","operationId":"carrierList","parameters":[{"in":"query","name":"status","description":"Filter by Status","required":false,"schema":{"type":"string"}},{"in":"query","name":"p_asserted_identity","description":"Filter by P Asserted Identity","required":false,"schema":{"type":"string","enum":["default","remove","if-available","required"]}},{"in":"query","name":"invoice_schedule","description":"Filter by Invoice Schedule","required":false,"schema":{"type":"string","enum":["day","week","bimonth","month","disabled"]}},{"in":"query","name":"default_stir_shaken_attestation","description":"Filter by Default Stir Shaken Attestation","required":false,"schema":{"type":"string","enum":["A","B","C"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/carrier"}},"example":[{"id":12345,"account_id":1,"reseller_id":1,"name":"Example Name","alias":"example_alias","channels":123,"cps":1.5,"system_id":1,"status":"Active","address1":"example_address1","address2":"example_address2","city":"example_city","county":10,"postcode":"example_postcode","website":"https://example.com","country":"US","credit_refresh_interval":123,"portal_json":"Sample portal_json text content","portal_url":"example_portal_url","portal_username":"example_portal_username","portal_password":"example_portal_password","email_credit_regex":"example_email_credit_regex","trace":1,"credit":99.99,"debit_limit":99.99,"tax":99.99,"snapshot_credit":99.99,"snapshot_timestamp":1000000,"currency":"USD","paypal":"example_paypal","portal_access":"example_portal_access","is_customer":true,"is_carrier":true,"last_call":1000000,"auto_login_key":"example_auto_login_key","connexcs_permission":"example_connexcs_permission","fr_timeout":1,"pre_ring_timeout":1,"post_ring_timeout":1,"p_asserted_identity":"default","reply_actions":"example_reply_actions","reply_actions_json":"example_reply_actions_json","did_api_id":1,"account_api_id":1,"resources_used":"base64-encoded-data","code_consistency":99.99,"code_consistency_points":99.99,"min_payment":99.99,"approved_cli_only":1,"invoice_schedule":"day","invoice_due_days":1,"propagate_username":1,"required":"mobile_verification","duration_latency_offset":99.99,"notes":"Sample notes text content","consec_backoff":1,"tags":"example_tags","vars":"Sample vars text content","topup_currencies":"example_topup_currencies","accounting_id":1,"invoice_template":"example_invoice_template","account_manager_id":1,"origid":"example_origid","rtp_firewall_warning":1,"s3_size":1.5,"call_recording_retention_days":123,"range_holder_provider_card_id":1,"domain_id":1,"cx_referal":1,"max_daily_spend":99.99,"dt_restrict":"example_dt_restrict","default_stir_shaken_attestation":"A","flags":"example_flags"},{"id":12345,"account_id":1,"reseller_id":1,"name":"Example Name","alias":"example_alias","channels":123,"cps":1.5,"system_id":1,"status":"Active","address1":"example_address1","address2":"example_address2","city":"example_city","county":10,"postcode":"example_postcode","website":"https://example.com","country":"US","credit_refresh_interval":123,"portal_json":"Sample portal_json text content","portal_url":"example_portal_url","portal_username":"example_portal_username","portal_password":"example_portal_password","email_credit_regex":"example_email_credit_regex","trace":1,"credit":99.99,"debit_limit":99.99,"tax":99.99,"snapshot_credit":99.99,"snapshot_timestamp":1000000,"currency":"USD","paypal":"example_paypal","portal_access":"example_portal_access","is_customer":true,"is_carrier":true,"last_call":1000000,"auto_login_key":"example_auto_login_key","connexcs_permission":"example_connexcs_permission","fr_timeout":1,"pre_ring_timeout":1,"post_ring_timeout":1,"p_asserted_identity":"default","reply_actions":"example_reply_actions","reply_actions_json":"example_reply_actions_json","did_api_id":1,"account_api_id":1,"resources_used":"base64-encoded-data","code_consistency":99.99,"code_consistency_points":99.99,"min_payment":99.99,"approved_cli_only":1,"invoice_schedule":"day","invoice_due_days":1,"propagate_username":1,"required":"mobile_verification","duration_latency_offset":99.99,"notes":"Sample notes text content","consec_backoff":1,"tags":"example_tags","vars":"Sample vars text content","topup_currencies":"example_topup_currencies","accounting_id":1,"invoice_template":"example_invoice_template","account_manager_id":1,"origid":"example_origid","rtp_firewall_warning":1,"s3_size":1.5,"call_recording_retention_days":123,"range_holder_provider_card_id":1,"domain_id":1,"cx_referal":1,"max_daily_spend":99.99,"dt_restrict":"example_dt_restrict","default_stir_shaken_attestation":"A","flags":"example_flags"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Carrier"],"summary":"Create","description":"Create a new Carrier record.","operationId":"carrierCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/carrierInput"},"example":{"account_id":1,"reseller_id":1,"name":"Example Name","alias":"example_alias","channels":123,"cps":1.5,"system_id":1,"status":"Active","address1":"example_address1","address2":"example_address2","city":"example_city","county":10,"postcode":"example_postcode","website":"https://example.com","country":"US","credit_refresh_interval":123,"portal_json":"Sample portal_json text content","portal_url":"example_portal_url","portal_username":"example_portal_username","portal_password":"example_portal_password","email_credit_regex":"example_email_credit_regex","trace":1,"credit":99.99,"debit_limit":99.99,"tax":99.99,"snapshot_credit":99.99,"snapshot_timestamp":1000000,"currency":"USD","paypal":"example_paypal","portal_access":"example_portal_access","is_customer":true,"is_carrier":true,"last_call":1000000,"auto_login_key":"example_auto_login_key","connexcs_permission":"example_connexcs_permission","fr_timeout":1,"pre_ring_timeout":1,"post_ring_timeout":1,"p_asserted_identity":"default","reply_actions":"example_reply_actions","reply_actions_json":"example_reply_actions_json","did_api_id":1,"account_api_id":1,"resources_used":"base64-encoded-data","code_consistency":99.99,"code_consistency_points":99.99,"min_payment":99.99,"approved_cli_only":1,"invoice_schedule":"day","invoice_due_days":1,"propagate_username":1,"required":"mobile_verification","duration_latency_offset":99.99,"notes":"Sample notes text content","consec_backoff":1,"tags":"example_tags","vars":"Sample vars text content","topup_currencies":"example_topup_currencies","accounting_id":1,"invoice_template":"example_invoice_template","account_manager_id":1,"origid":"example_origid","rtp_firewall_warning":1,"s3_size":1.5,"call_recording_retention_days":123,"range_holder_provider_card_id":1,"domain_id":1,"cx_referal":1,"max_daily_spend":99.99,"dt_restrict":"example_dt_restrict","default_stir_shaken_attestation":"A","flags":"example_flags"}}}}}},"/api/cp/carrier/email":{"post":{"tags":["Carrier"],"summary":"Email","description":"Email","operationId":"carrierEmail","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/carrierInput"},"example":{"account_id":1,"reseller_id":1,"name":"Example Name","alias":"example_alias","channels":123,"cps":1.5,"system_id":1,"status":"Active","address1":"example_address1","address2":"example_address2","city":"example_city","county":10,"postcode":"example_postcode","website":"https://example.com","country":"US","credit_refresh_interval":123,"portal_json":"Sample portal_json text content","portal_url":"example_portal_url","portal_username":"example_portal_username","portal_password":"example_portal_password","email_credit_regex":"example_email_credit_regex","trace":1,"credit":99.99,"debit_limit":99.99,"tax":99.99,"snapshot_credit":99.99,"snapshot_timestamp":1000000,"currency":"USD","paypal":"example_paypal","portal_access":"example_portal_access","is_customer":true,"is_carrier":true,"last_call":1000000,"auto_login_key":"example_auto_login_key","connexcs_permission":"example_connexcs_permission","fr_timeout":1,"pre_ring_timeout":1,"post_ring_timeout":1,"p_asserted_identity":"default","reply_actions":"example_reply_actions","reply_actions_json":"example_reply_actions_json","did_api_id":1,"account_api_id":1,"resources_used":"base64-encoded-data","code_consistency":99.99,"code_consistency_points":99.99,"min_payment":99.99,"approved_cli_only":1,"invoice_schedule":"day","invoice_due_days":1,"propagate_username":1,"required":"mobile_verification","duration_latency_offset":99.99,"notes":"Sample notes text content","consec_backoff":1,"tags":"example_tags","vars":"Sample vars text content","topup_currencies":"example_topup_currencies","accounting_id":1,"invoice_template":"example_invoice_template","account_manager_id":1,"origid":"example_origid","rtp_firewall_warning":1,"s3_size":1.5,"call_recording_retention_days":123,"range_holder_provider_card_id":1,"domain_id":1,"cx_referal":1,"max_daily_spend":99.99,"dt_restrict":"example_dt_restrict","default_stir_shaken_attestation":"A","flags":"example_flags"}}}}}},"/api/cp/carrier/heuristics-report":{"post":{"tags":["Carrier"],"summary":"Heuristics Report","description":"Heuristics Report","operationId":"carrierHeuristicsReport","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/carrierInput"},"example":{"account_id":1,"reseller_id":1,"name":"Example Name","alias":"example_alias","channels":123,"cps":1.5,"system_id":1,"status":"Active","address1":"example_address1","address2":"example_address2","city":"example_city","county":10,"postcode":"example_postcode","website":"https://example.com","country":"US","credit_refresh_interval":123,"portal_json":"Sample portal_json text content","portal_url":"example_portal_url","portal_username":"example_portal_username","portal_password":"example_portal_password","email_credit_regex":"example_email_credit_regex","trace":1,"credit":99.99,"debit_limit":99.99,"tax":99.99,"snapshot_credit":99.99,"snapshot_timestamp":1000000,"currency":"USD","paypal":"example_paypal","portal_access":"example_portal_access","is_customer":true,"is_carrier":true,"last_call":1000000,"auto_login_key":"example_auto_login_key","connexcs_permission":"example_connexcs_permission","fr_timeout":1,"pre_ring_timeout":1,"post_ring_timeout":1,"p_asserted_identity":"default","reply_actions":"example_reply_actions","reply_actions_json":"example_reply_actions_json","did_api_id":1,"account_api_id":1,"resources_used":"base64-encoded-data","code_consistency":99.99,"code_consistency_points":99.99,"min_payment":99.99,"approved_cli_only":1,"invoice_schedule":"day","invoice_due_days":1,"propagate_username":1,"required":"mobile_verification","duration_latency_offset":99.99,"notes":"Sample notes text content","consec_backoff":1,"tags":"example_tags","vars":"Sample vars text content","topup_currencies":"example_topup_currencies","accounting_id":1,"invoice_template":"example_invoice_template","account_manager_id":1,"origid":"example_origid","rtp_firewall_warning":1,"s3_size":1.5,"call_recording_retention_days":123,"range_holder_provider_card_id":1,"domain_id":1,"cx_referal":1,"max_daily_spend":99.99,"dt_restrict":"example_dt_restrict","default_stir_shaken_attestation":"A","flags":"example_flags"}}}}}},"/api/cp/carrier/referral":{"post":{"tags":["Carrier"],"summary":"Referral","description":"Referral","operationId":"carrierReferral","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/carrierInput"},"example":{"account_id":1,"reseller_id":1,"name":"Example Name","alias":"example_alias","channels":123,"cps":1.5,"system_id":1,"status":"Active","address1":"example_address1","address2":"example_address2","city":"example_city","county":10,"postcode":"example_postcode","website":"https://example.com","country":"US","credit_refresh_interval":123,"portal_json":"Sample portal_json text content","portal_url":"example_portal_url","portal_username":"example_portal_username","portal_password":"example_portal_password","email_credit_regex":"example_email_credit_regex","trace":1,"credit":99.99,"debit_limit":99.99,"tax":99.99,"snapshot_credit":99.99,"snapshot_timestamp":1000000,"currency":"USD","paypal":"example_paypal","portal_access":"example_portal_access","is_customer":true,"is_carrier":true,"last_call":1000000,"auto_login_key":"example_auto_login_key","connexcs_permission":"example_connexcs_permission","fr_timeout":1,"pre_ring_timeout":1,"post_ring_timeout":1,"p_asserted_identity":"default","reply_actions":"example_reply_actions","reply_actions_json":"example_reply_actions_json","did_api_id":1,"account_api_id":1,"resources_used":"base64-encoded-data","code_consistency":99.99,"code_consistency_points":99.99,"min_payment":99.99,"approved_cli_only":1,"invoice_schedule":"day","invoice_due_days":1,"propagate_username":1,"required":"mobile_verification","duration_latency_offset":99.99,"notes":"Sample notes text content","consec_backoff":1,"tags":"example_tags","vars":"Sample vars text content","topup_currencies":"example_topup_currencies","accounting_id":1,"invoice_template":"example_invoice_template","account_manager_id":1,"origid":"example_origid","rtp_firewall_warning":1,"s3_size":1.5,"call_recording_retention_days":123,"range_holder_provider_card_id":1,"domain_id":1,"cx_referal":1,"max_daily_spend":99.99,"dt_restrict":"example_dt_restrict","default_stir_shaken_attestation":"A","flags":"example_flags"}}}}}},"/api/cp/carrier/sms":{"post":{"tags":["Carrier"],"summary":"SMS","description":"SMS","operationId":"carrierSms","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/carrierInput"},"example":{"account_id":1,"reseller_id":1,"name":"Example Name","alias":"example_alias","channels":123,"cps":1.5,"system_id":1,"status":"Active","address1":"example_address1","address2":"example_address2","city":"example_city","county":10,"postcode":"example_postcode","website":"https://example.com","country":"US","credit_refresh_interval":123,"portal_json":"Sample portal_json text content","portal_url":"example_portal_url","portal_username":"example_portal_username","portal_password":"example_portal_password","email_credit_regex":"example_email_credit_regex","trace":1,"credit":99.99,"debit_limit":99.99,"tax":99.99,"snapshot_credit":99.99,"snapshot_timestamp":1000000,"currency":"USD","paypal":"example_paypal","portal_access":"example_portal_access","is_customer":true,"is_carrier":true,"last_call":1000000,"auto_login_key":"example_auto_login_key","connexcs_permission":"example_connexcs_permission","fr_timeout":1,"pre_ring_timeout":1,"post_ring_timeout":1,"p_asserted_identity":"default","reply_actions":"example_reply_actions","reply_actions_json":"example_reply_actions_json","did_api_id":1,"account_api_id":1,"resources_used":"base64-encoded-data","code_consistency":99.99,"code_consistency_points":99.99,"min_payment":99.99,"approved_cli_only":1,"invoice_schedule":"day","invoice_due_days":1,"propagate_username":1,"required":"mobile_verification","duration_latency_offset":99.99,"notes":"Sample notes text content","consec_backoff":1,"tags":"example_tags","vars":"Sample vars text content","topup_currencies":"example_topup_currencies","accounting_id":1,"invoice_template":"example_invoice_template","account_manager_id":1,"origid":"example_origid","rtp_firewall_warning":1,"s3_size":1.5,"call_recording_retention_days":123,"range_holder_provider_card_id":1,"domain_id":1,"cx_referal":1,"max_daily_spend":99.99,"dt_restrict":"example_dt_restrict","default_stir_shaken_attestation":"A","flags":"example_flags"}}}}}},"/api/cp/carrier/trust-score-report":{"get":{"tags":["Carrier"],"summary":"Trust Score Report","description":"Trust Score Report","operationId":"carrierTrustScoreReport","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/carrier"},"example":{"id":12345,"account_id":1,"reseller_id":1,"name":"Example Name","alias":"example_alias","channels":123,"cps":1.5,"system_id":1,"status":"Active","address1":"example_address1","address2":"example_address2","city":"example_city","county":10,"postcode":"example_postcode","website":"https://example.com","country":"US","credit_refresh_interval":123,"portal_json":"Sample portal_json text content","portal_url":"example_portal_url","portal_username":"example_portal_username","portal_password":"example_portal_password","email_credit_regex":"example_email_credit_regex","trace":1,"credit":99.99,"debit_limit":99.99,"tax":99.99,"snapshot_credit":99.99,"snapshot_timestamp":1000000,"currency":"USD","paypal":"example_paypal","portal_access":"example_portal_access","is_customer":true,"is_carrier":true,"last_call":1000000,"auto_login_key":"example_auto_login_key","connexcs_permission":"example_connexcs_permission","fr_timeout":1,"pre_ring_timeout":1,"post_ring_timeout":1,"p_asserted_identity":"default","reply_actions":"example_reply_actions","reply_actions_json":"example_reply_actions_json","did_api_id":1,"account_api_id":1,"resources_used":"base64-encoded-data","code_consistency":99.99,"code_consistency_points":99.99,"min_payment":99.99,"approved_cli_only":1,"invoice_schedule":"day","invoice_due_days":1,"propagate_username":1,"required":"mobile_verification","duration_latency_offset":99.99,"notes":"Sample notes text content","consec_backoff":1,"tags":"example_tags","vars":"Sample vars text content","topup_currencies":"example_topup_currencies","accounting_id":1,"invoice_template":"example_invoice_template","account_manager_id":1,"origid":"example_origid","rtp_firewall_warning":1,"s3_size":1.5,"call_recording_retention_days":123,"range_holder_provider_card_id":1,"domain_id":1,"cx_referal":1,"max_daily_spend":99.99,"dt_restrict":"example_dt_restrict","default_stir_shaken_attestation":"A","flags":"example_flags"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/carrier/{carrierId}/latest/failover":{"get":{"tags":["Latest"],"summary":"Failover","description":"Failover","operationId":"latestFailover","parameters":[{"in":"path","name":"carrierId","description":"Carrier Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/carrier/{id}":{"get":{"tags":["Carrier"],"summary":"Read","description":"Retrieve a single Carrier record by ID.","operationId":"carrierRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/carrier"},"example":{"id":12345,"account_id":1,"reseller_id":1,"name":"Example Name","alias":"example_alias","channels":123,"cps":1.5,"system_id":1,"status":"Active","address1":"example_address1","address2":"example_address2","city":"example_city","county":10,"postcode":"example_postcode","website":"https://example.com","country":"US","credit_refresh_interval":123,"portal_json":"Sample portal_json text content","portal_url":"example_portal_url","portal_username":"example_portal_username","portal_password":"example_portal_password","email_credit_regex":"example_email_credit_regex","trace":1,"credit":99.99,"debit_limit":99.99,"tax":99.99,"snapshot_credit":99.99,"snapshot_timestamp":1000000,"currency":"USD","paypal":"example_paypal","portal_access":"example_portal_access","is_customer":true,"is_carrier":true,"last_call":1000000,"auto_login_key":"example_auto_login_key","connexcs_permission":"example_connexcs_permission","fr_timeout":1,"pre_ring_timeout":1,"post_ring_timeout":1,"p_asserted_identity":"default","reply_actions":"example_reply_actions","reply_actions_json":"example_reply_actions_json","did_api_id":1,"account_api_id":1,"resources_used":"base64-encoded-data","code_consistency":99.99,"code_consistency_points":99.99,"min_payment":99.99,"approved_cli_only":1,"invoice_schedule":"day","invoice_due_days":1,"propagate_username":1,"required":"mobile_verification","duration_latency_offset":99.99,"notes":"Sample notes text content","consec_backoff":1,"tags":"example_tags","vars":"Sample vars text content","topup_currencies":"example_topup_currencies","accounting_id":1,"invoice_template":"example_invoice_template","account_manager_id":1,"origid":"example_origid","rtp_firewall_warning":1,"s3_size":1.5,"call_recording_retention_days":123,"range_holder_provider_card_id":1,"domain_id":1,"cx_referal":1,"max_daily_spend":99.99,"dt_restrict":"example_dt_restrict","default_stir_shaken_attestation":"A","flags":"example_flags"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Carrier"],"summary":"Update","description":"Update an existing Carrier record by ID.","operationId":"carrierUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/carrierInput"},"example":{"account_id":1,"reseller_id":1,"name":"Example Name","alias":"example_alias","channels":123,"cps":1.5,"system_id":1,"status":"Active","address1":"example_address1","address2":"example_address2","city":"example_city","county":10,"postcode":"example_postcode","website":"https://example.com","country":"US","credit_refresh_interval":123,"portal_json":"Sample portal_json text content","portal_url":"example_portal_url","portal_username":"example_portal_username","portal_password":"example_portal_password","email_credit_regex":"example_email_credit_regex","trace":1,"credit":99.99,"debit_limit":99.99,"tax":99.99,"snapshot_credit":99.99,"snapshot_timestamp":1000000,"currency":"USD","paypal":"example_paypal","portal_access":"example_portal_access","is_customer":true,"is_carrier":true,"last_call":1000000,"auto_login_key":"example_auto_login_key","connexcs_permission":"example_connexcs_permission","fr_timeout":1,"pre_ring_timeout":1,"post_ring_timeout":1,"p_asserted_identity":"default","reply_actions":"example_reply_actions","reply_actions_json":"example_reply_actions_json","did_api_id":1,"account_api_id":1,"resources_used":"base64-encoded-data","code_consistency":99.99,"code_consistency_points":99.99,"min_payment":99.99,"approved_cli_only":1,"invoice_schedule":"day","invoice_due_days":1,"propagate_username":1,"required":"mobile_verification","duration_latency_offset":99.99,"notes":"Sample notes text content","consec_backoff":1,"tags":"example_tags","vars":"Sample vars text content","topup_currencies":"example_topup_currencies","accounting_id":1,"invoice_template":"example_invoice_template","account_manager_id":1,"origid":"example_origid","rtp_firewall_warning":1,"s3_size":1.5,"call_recording_retention_days":123,"range_holder_provider_card_id":1,"domain_id":1,"cx_referal":1,"max_daily_spend":99.99,"dt_restrict":"example_dt_restrict","default_stir_shaken_attestation":"A","flags":"example_flags"}}}}},"delete":{"tags":["Carrier"],"summary":"Delete","description":"Delete a Carrier record by ID.","operationId":"carrierDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/carrier/{id}/reset-consec-fail":{"get":{"tags":["Carrier"],"summary":"Reset Consec Fail","description":"Reset Consec Fail","operationId":"carrierResetConsecFail","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/carrier"},"example":{"id":12345,"account_id":1,"reseller_id":1,"name":"Example Name","alias":"example_alias","channels":123,"cps":1.5,"system_id":1,"status":"Active","address1":"example_address1","address2":"example_address2","city":"example_city","county":10,"postcode":"example_postcode","website":"https://example.com","country":"US","credit_refresh_interval":123,"portal_json":"Sample portal_json text content","portal_url":"example_portal_url","portal_username":"example_portal_username","portal_password":"example_portal_password","email_credit_regex":"example_email_credit_regex","trace":1,"credit":99.99,"debit_limit":99.99,"tax":99.99,"snapshot_credit":99.99,"snapshot_timestamp":1000000,"currency":"USD","paypal":"example_paypal","portal_access":"example_portal_access","is_customer":true,"is_carrier":true,"last_call":1000000,"auto_login_key":"example_auto_login_key","connexcs_permission":"example_connexcs_permission","fr_timeout":1,"pre_ring_timeout":1,"post_ring_timeout":1,"p_asserted_identity":"default","reply_actions":"example_reply_actions","reply_actions_json":"example_reply_actions_json","did_api_id":1,"account_api_id":1,"resources_used":"base64-encoded-data","code_consistency":99.99,"code_consistency_points":99.99,"min_payment":99.99,"approved_cli_only":1,"invoice_schedule":"day","invoice_due_days":1,"propagate_username":1,"required":"mobile_verification","duration_latency_offset":99.99,"notes":"Sample notes text content","consec_backoff":1,"tags":"example_tags","vars":"Sample vars text content","topup_currencies":"example_topup_currencies","accounting_id":1,"invoice_template":"example_invoice_template","account_manager_id":1,"origid":"example_origid","rtp_firewall_warning":1,"s3_size":1.5,"call_recording_retention_days":123,"range_holder_provider_card_id":1,"domain_id":1,"cx_referal":1,"max_daily_spend":99.99,"dt_restrict":"example_dt_restrict","default_stir_shaken_attestation":"A","flags":"example_flags"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/cdr":{"query":{"tags":["Cdr"],"summary":"Query [QUERY]","description":"Query [QUERY]","operationId":"cdrQueryQuery","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/cdr(.{ext)}":{"post":{"tags":["Cdr"],"summary":"Query Advanced","description":"Query Advanced","operationId":"cdrQueryAdvanced","parameters":[{"in":"path","name":"ext)","description":"Ext identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"requestBody":{"description":"Request Body Description","content":{"application/json":{"schema":{"example":{"field":["dt","callid","dest_cli","dest_number","duration","customer_id","customer_charge","customer_card_currency","provider_id","provider_charge","provider_card_currency"],"where":{"rules":[{"field":"dt","condition":">=","data":"2024-01-01"},{"field":"dt","condition":"<=","data":"2024-01-01T23:59:59.000Z"}]},"limit":5000,"order":[]}}}}},"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/cdr-action":{"get":{"tags":["Cdr Action"],"summary":"List","description":"Retrieve a paginated list of Cdr Action records. Supports filtering, sorting, and search.","operationId":"cdrActionList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/cdr/recalc":{"post":{"tags":["Cdr Action"],"summary":"Run Recalc","description":"Run Recalc","operationId":"cdrActionRunRecalc","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/cdr/{accountType}/{companyId}/{start_date}/{end_date}(.{ext)}":{"get":{"tags":["Cdr"],"summary":"Query","description":"Query","operationId":"cdrQuery","parameters":[{"in":"path","name":"accountType","description":"Account Type identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"companyId","description":"Company Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"start_date","description":"Start Date identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"end_date","description":"End Date identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"ext)","description":"Ext identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/circuit-test":{"get":{"tags":["Circuit Test"],"summary":"List","description":"Retrieve a paginated list of Circuit Test records. Supports filtering, sorting, and search.","operationId":"circuitTestList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/circuitTest"}},"example":[{"id":12345,"account_id":1,"provider_id":1,"card_id":1,"dt":"2025-01-17T10:30:00Z","callid_a":"example_callid_a","callid_b":"example_callid_b","fas":1,"fas_type":"example_fas_type","dest_number":"example_dest_number","in_mos":1.5,"in_dtmf":"example_in_dtmf","in_cli":"example_in_cli","in_codec":"example_in_codec","in_audio_engagement_delay":1.5,"out_mos":1.5,"out_dtmf":"example_out_dtmf","out_cli":"example_out_cli","out_codec":"example_out_codec","out_audio_engagement_delay":1.5,"cli":1.5,"mos":1.5,"delay100":1.5,"delay180":1.5,"delay183":1.5,"delay_audio":1.5,"codec":"example_codec","release":"example_release","release_status":"example_release_status","answer_diff":123,"release_diff":123},{"id":12345,"account_id":1,"provider_id":1,"card_id":1,"dt":"2025-01-17T10:30:00Z","callid_a":"example_callid_a","callid_b":"example_callid_b","fas":1,"fas_type":"example_fas_type","dest_number":"example_dest_number","in_mos":1.5,"in_dtmf":"example_in_dtmf","in_cli":"example_in_cli","in_codec":"example_in_codec","in_audio_engagement_delay":1.5,"out_mos":1.5,"out_dtmf":"example_out_dtmf","out_cli":"example_out_cli","out_codec":"example_out_codec","out_audio_engagement_delay":1.5,"cli":1.5,"mos":1.5,"delay100":1.5,"delay180":1.5,"delay183":1.5,"delay_audio":1.5,"codec":"example_codec","release":"example_release","release_status":"example_release_status","answer_diff":123,"release_diff":123}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Circuit Test"],"summary":"Run Test","description":"Run Test","operationId":"circuitTestRunTest","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/circuitTestInput"},"example":{"account_id":1,"provider_id":1,"card_id":1,"dt":"2025-01-17T10:30:00Z","callid_a":"example_callid_a","callid_b":"example_callid_b","fas":1,"fas_type":"example_fas_type","dest_number":"example_dest_number","in_mos":1.5,"in_dtmf":"example_in_dtmf","in_cli":"example_in_cli","in_codec":"example_in_codec","in_audio_engagement_delay":1.5,"out_mos":1.5,"out_dtmf":"example_out_dtmf","out_cli":"example_out_cli","out_codec":"example_out_codec","out_audio_engagement_delay":1.5,"cli":1.5,"mos":1.5,"delay100":1.5,"delay180":1.5,"delay183":1.5,"delay_audio":1.5,"codec":"example_codec","release":"example_release","release_status":"example_release_status","answer_diff":123,"release_diff":123}}}}}},"/api/cp/circuit-test-schedule":{"get":{"tags":["Circuit Test Schedule"],"summary":"List","description":"Retrieve a paginated list of Circuit Test Schedule records. Supports filtering, sorting, and search.","operationId":"circuitTestScheduleList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/circuitTestSchedule"}},"example":[{"id":12345,"account_id":1,"provider_id":1,"card_id":1,"name":"Example Name","schedule":"example_schedule","cli":"example_cli","dest_number":"example_dest_number","interval":1},{"id":12345,"account_id":1,"provider_id":1,"card_id":1,"name":"Example Name","schedule":"example_schedule","cli":"example_cli","dest_number":"example_dest_number","interval":1}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Circuit Test Schedule"],"summary":"Create","description":"Create a new Circuit Test Schedule record.","operationId":"circuitTestScheduleCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/circuitTestScheduleInput"},"example":{"account_id":1,"provider_id":1,"card_id":1,"name":"Example Name","schedule":"example_schedule","cli":"example_cli","dest_number":"example_dest_number","interval":1}}}}}},"/api/cp/circuit-test-schedule/{id}":{"get":{"tags":["Circuit Test Schedule"],"summary":"Read","description":"Retrieve a single Circuit Test Schedule record by ID.","operationId":"circuitTestScheduleRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/circuitTestSchedule"},"example":{"id":12345,"account_id":1,"provider_id":1,"card_id":1,"name":"Example Name","schedule":"example_schedule","cli":"example_cli","dest_number":"example_dest_number","interval":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Circuit Test Schedule"],"summary":"Update","description":"Update an existing Circuit Test Schedule record by ID.","operationId":"circuitTestScheduleUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/circuitTestScheduleInput"},"example":{"account_id":1,"provider_id":1,"card_id":1,"name":"Example Name","schedule":"example_schedule","cli":"example_cli","dest_number":"example_dest_number","interval":1}}}}},"delete":{"tags":["Circuit Test Schedule"],"summary":"Delete","description":"Delete a Circuit Test Schedule record by ID.","operationId":"circuitTestScheduleDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/class5/ai-agent":{"get":{"tags":["Class 5 - AI Agent"],"summary":"List","description":"Retrieve a paginated list of Class 5 - AI Agent records. Supports filtering, sorting, and search.","operationId":"class5AiAgentList","parameters":[{"in":"query","name":"platform","description":"Filter by Platform","required":false,"schema":{"type":"string","enum":["openai","converse","converse-direct","converse2"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/class5AiAgent"}},"example":[{"id":12345,"account_id":1,"company_id":1,"app_id":1,"dest":"example_dest","host":"example_host","pbx_server":"example_pbx_server","name":"Example Name","prompt":"Sample prompt text content","platform":"openai","provider":"example_provider","model":"example_model","transcriber":"example_transcriber","transcriber_model":"example_transcriber_model","transcriber_silence_threshold":99.99,"transcriber_language":"example_transcriber_language","tts":"example_tts","voice":"example_voice","first_message":"example_first_message","endpoint_id":1,"vad":1,"early_end_turn_threshold":99.99,"end_turn_threshold":99.99,"temperature":99.99,"built_in_functions":"example_built_in_functions","end_call_phrases":"example_end_call_phrases","interrupt_delay":99.99,"guard_rails":"example_guard_rails","filler_words":"example_filler_words","min_filler_word_delay":99.99,"office_background_volume":99.99,"flags":"ASYNC_GUARD_RAILS","llm_timeout":99.99,"llm_retries":1,"amd_keywords":"example_amd_keywords","vars":"example_vars","transcriber_timeout":1,"tool_call_allow_list":"example_tool_call_allow_list","precache_phrases":"example_precache_phrases","first_task_id":1,"kb_id":1,"asr_provider_config_id":1,"llm_provider_config_id":1,"tts_provider_config_id":1,"s2s_provider_config_id":1,"mcp_servers":"Sample mcp_servers text content"},{"id":12345,"account_id":1,"company_id":1,"app_id":1,"dest":"example_dest","host":"example_host","pbx_server":"example_pbx_server","name":"Example Name","prompt":"Sample prompt text content","platform":"openai","provider":"example_provider","model":"example_model","transcriber":"example_transcriber","transcriber_model":"example_transcriber_model","transcriber_silence_threshold":99.99,"transcriber_language":"example_transcriber_language","tts":"example_tts","voice":"example_voice","first_message":"example_first_message","endpoint_id":1,"vad":1,"early_end_turn_threshold":99.99,"end_turn_threshold":99.99,"temperature":99.99,"built_in_functions":"example_built_in_functions","end_call_phrases":"example_end_call_phrases","interrupt_delay":99.99,"guard_rails":"example_guard_rails","filler_words":"example_filler_words","min_filler_word_delay":99.99,"office_background_volume":99.99,"flags":"ASYNC_GUARD_RAILS","llm_timeout":99.99,"llm_retries":1,"amd_keywords":"example_amd_keywords","vars":"example_vars","transcriber_timeout":1,"tool_call_allow_list":"example_tool_call_allow_list","precache_phrases":"example_precache_phrases","first_task_id":1,"kb_id":1,"asr_provider_config_id":1,"llm_provider_config_id":1,"tts_provider_config_id":1,"s2s_provider_config_id":1,"mcp_servers":"Sample mcp_servers text content"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Class 5 - AI Agent"],"summary":"Create","description":"Create a new Class 5 - AI Agent record.","operationId":"class5AiAgentCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5AiAgentInput"},"example":{"account_id":1,"company_id":1,"app_id":1,"dest":"example_dest","host":"example_host","pbx_server":"example_pbx_server","name":"Example Name","prompt":"Sample prompt text content","platform":"openai","provider":"example_provider","model":"example_model","transcriber":"example_transcriber","transcriber_model":"example_transcriber_model","transcriber_silence_threshold":99.99,"transcriber_language":"example_transcriber_language","tts":"example_tts","voice":"example_voice","first_message":"example_first_message","endpoint_id":1,"vad":1,"early_end_turn_threshold":99.99,"end_turn_threshold":99.99,"temperature":99.99,"built_in_functions":"example_built_in_functions","end_call_phrases":"example_end_call_phrases","interrupt_delay":99.99,"guard_rails":"example_guard_rails","filler_words":"example_filler_words","min_filler_word_delay":99.99,"office_background_volume":99.99,"flags":"ASYNC_GUARD_RAILS","llm_timeout":99.99,"llm_retries":1,"amd_keywords":"example_amd_keywords","vars":"example_vars","transcriber_timeout":1,"tool_call_allow_list":"example_tool_call_allow_list","precache_phrases":"example_precache_phrases","first_task_id":1,"kb_id":1,"asr_provider_config_id":1,"llm_provider_config_id":1,"tts_provider_config_id":1,"s2s_provider_config_id":1,"mcp_servers":"Sample mcp_servers text content"}}}}}},"/api/cp/class5/ai-agent-provider":{"get":{"tags":["Class 5 AI Agent Provider"],"summary":"List","description":"Retrieve a paginated list of Class 5 AI Agent Provider records. Supports filtering, sorting, and search.","operationId":"class5AiAgentProviderList","parameters":[{"in":"query","name":"component_type","description":"Filter by Component Type","required":false,"schema":{"type":"string","enum":["asr","tts","llm","s2s","recording","memory","audio_processing","observability"]}},{"in":"query","name":"scope","description":"Filter by Scope","required":false,"schema":{"type":"string","enum":["system","user"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/class5AiAgentProvider"}},"example":[{"id":12345,"component_type":"asr","provider":"example_provider","name":"Example Name","scope":"system","account_id":1,"settings":"Sample settings text content","is_default":true,"enabled":true,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z","default_slot":1,"model":"example_model","abstract":"example_abstract"},{"id":12345,"component_type":"asr","provider":"example_provider","name":"Example Name","scope":"system","account_id":1,"settings":"Sample settings text content","is_default":true,"enabled":true,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z","default_slot":1,"model":"example_model","abstract":"example_abstract"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Class 5 AI Agent Provider"],"summary":"Create","description":"Create a new Class 5 AI Agent Provider record.","operationId":"class5AiAgentProviderCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5AiAgentProviderInput"},"example":{"component_type":"asr","provider":"example_provider","name":"Example Name","scope":"system","account_id":1,"settings":"Sample settings text content","is_default":true,"enabled":true,"default_slot":1,"model":"example_model","abstract":"example_abstract"}}}}}},"/api/cp/class5/ai-agent-provider/{id}":{"get":{"tags":["Class 5 AI Agent Provider"],"summary":"Read","description":"Retrieve a single Class 5 AI Agent Provider record by ID.","operationId":"class5AiAgentProviderRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5AiAgentProvider"},"example":{"id":12345,"component_type":"asr","provider":"example_provider","name":"Example Name","scope":"system","account_id":1,"settings":"Sample settings text content","is_default":true,"enabled":true,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z","default_slot":1,"model":"example_model","abstract":"example_abstract"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Class 5 AI Agent Provider"],"summary":"Update","description":"Update an existing Class 5 AI Agent Provider record by ID.","operationId":"class5AiAgentProviderUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5AiAgentProviderInput"},"example":{"component_type":"asr","provider":"example_provider","name":"Example Name","scope":"system","account_id":1,"settings":"Sample settings text content","is_default":true,"enabled":true,"default_slot":1,"model":"example_model","abstract":"example_abstract"}}}}},"delete":{"tags":["Class 5 AI Agent Provider"],"summary":"Delete","description":"Delete a Class 5 AI Agent Provider record by ID.","operationId":"class5AiAgentProviderDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/class5/ai-agent-task":{"get":{"tags":["Class 5 AI Agent Task"],"summary":"List","description":"Retrieve a paginated list of Class 5 AI Agent Task records. Supports filtering, sorting, and search.","operationId":"class5AiAgentTaskList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/class5AiAgentTask"}},"example":[{"id":12345,"ai_agent_id":1,"name":"Example Name","model":"example_model","prompt":"example_prompt","flags":"INCLUDE_PRIMARY_PROMPT","transcriber":"example_transcriber","transcriber_model":"example_transcriber_model","transcriber_language":"example_transcriber_language","tts":"example_tts","voice":"example_voice","first_message":"example_first_message","vad":1,"temperature":99.99,"built_in_functions":"example_built_in_functions","guard_rails":"example_guard_rails","office_background_volume":99.99,"vars":"example_vars","tool_call_allow_list":"example_tool_call_allow_list"},{"id":12345,"ai_agent_id":1,"name":"Example Name","model":"example_model","prompt":"example_prompt","flags":"INCLUDE_PRIMARY_PROMPT","transcriber":"example_transcriber","transcriber_model":"example_transcriber_model","transcriber_language":"example_transcriber_language","tts":"example_tts","voice":"example_voice","first_message":"example_first_message","vad":1,"temperature":99.99,"built_in_functions":"example_built_in_functions","guard_rails":"example_guard_rails","office_background_volume":99.99,"vars":"example_vars","tool_call_allow_list":"example_tool_call_allow_list"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Class 5 AI Agent Task"],"summary":"Create","description":"Create a new Class 5 AI Agent Task record.","operationId":"class5AiAgentTaskCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5AiAgentTaskInput"},"example":{"ai_agent_id":1,"name":"Example Name","model":"example_model","prompt":"example_prompt","flags":"INCLUDE_PRIMARY_PROMPT","transcriber":"example_transcriber","transcriber_model":"example_transcriber_model","transcriber_language":"example_transcriber_language","tts":"example_tts","voice":"example_voice","first_message":"example_first_message","vad":1,"temperature":99.99,"built_in_functions":"example_built_in_functions","guard_rails":"example_guard_rails","office_background_volume":99.99,"vars":"example_vars","tool_call_allow_list":"example_tool_call_allow_list"}}}}}},"/api/cp/class5/ai-agent-task-link":{"get":{"tags":["Class 5 AI Agent Task"],"summary":"List","description":"Retrieve a paginated list of Class 5 AI Agent Task records. Supports filtering, sorting, and search.","operationId":"class5AiAgentTaskList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/class5AiAgentTask"}},"example":[{"id":12345,"ai_agent":"example_ai_agent","ai_agent_task_id":1,"next_ai_agent_task_id":1,"condition":"example_condition"},{"id":12345,"ai_agent":"example_ai_agent","ai_agent_task_id":1,"next_ai_agent_task_id":1,"condition":"example_condition"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Class 5 AI Agent Task"],"summary":"Create","description":"Create a new Class 5 AI Agent Task record.","operationId":"class5AiAgentTaskCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5AiAgentTaskInput"},"example":{"ai_agent":"example_ai_agent","ai_agent_task_id":1,"next_ai_agent_task_id":1,"condition":"example_condition"}}}}}},"/api/cp/class5/ai-agent-task-link/{id}":{"get":{"tags":["Class 5 AI Agent Task"],"summary":"Read","description":"Retrieve a single Class 5 AI Agent Task record by ID.","operationId":"class5AiAgentTaskRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5AiAgentTask"},"example":{"id":12345,"ai_agent":"example_ai_agent","ai_agent_task_id":1,"next_ai_agent_task_id":1,"condition":"example_condition"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Class 5 AI Agent Task"],"summary":"Update","description":"Update an existing Class 5 AI Agent Task record by ID.","operationId":"class5AiAgentTaskUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5AiAgentTaskInput"},"example":{"ai_agent":"example_ai_agent","ai_agent_task_id":1,"next_ai_agent_task_id":1,"condition":"example_condition"}}}}},"delete":{"tags":["Class 5 AI Agent Task"],"summary":"Delete","description":"Delete a Class 5 AI Agent Task record by ID.","operationId":"class5AiAgentTaskDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/class5/ai-agent-task/{id}":{"get":{"tags":["Class 5 AI Agent Task"],"summary":"Read","description":"Retrieve a single Class 5 AI Agent Task record by ID.","operationId":"class5AiAgentTaskRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5AiAgentTask"},"example":{"id":12345,"ai_agent_id":1,"name":"Example Name","model":"example_model","prompt":"example_prompt","flags":"INCLUDE_PRIMARY_PROMPT","transcriber":"example_transcriber","transcriber_model":"example_transcriber_model","transcriber_language":"example_transcriber_language","tts":"example_tts","voice":"example_voice","first_message":"example_first_message","vad":1,"temperature":99.99,"built_in_functions":"example_built_in_functions","guard_rails":"example_guard_rails","office_background_volume":99.99,"vars":"example_vars","tool_call_allow_list":"example_tool_call_allow_list"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Class 5 AI Agent Task"],"summary":"Update","description":"Update an existing Class 5 AI Agent Task record by ID.","operationId":"class5AiAgentTaskUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5AiAgentTaskInput"},"example":{"ai_agent_id":1,"name":"Example Name","model":"example_model","prompt":"example_prompt","flags":"INCLUDE_PRIMARY_PROMPT","transcriber":"example_transcriber","transcriber_model":"example_transcriber_model","transcriber_language":"example_transcriber_language","tts":"example_tts","voice":"example_voice","first_message":"example_first_message","vad":1,"temperature":99.99,"built_in_functions":"example_built_in_functions","guard_rails":"example_guard_rails","office_background_volume":99.99,"vars":"example_vars","tool_call_allow_list":"example_tool_call_allow_list"}}}}},"delete":{"tags":["Class 5 AI Agent Task"],"summary":"Delete","description":"Delete a Class 5 AI Agent Task record by ID.","operationId":"class5AiAgentTaskDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/class5/ai-agent-test":{"get":{"tags":["Class 5 AI Agent Test"],"summary":"List","description":"Retrieve a paginated list of Class 5 AI Agent Test records. Supports filtering, sorting, and search.","operationId":"class5AiAgentTestList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/class5AiAgentTest"}},"example":[{"id":12345,"account_id":1,"agent_id":1,"name":"Example Name","conversation":"Sample conversation text content","criteria":"Sample criteria text content"},{"id":12345,"account_id":1,"agent_id":1,"name":"Example Name","conversation":"Sample conversation text content","criteria":"Sample criteria text content"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Class 5 AI Agent Test"],"summary":"Create","description":"Create a new Class 5 AI Agent Test record.","operationId":"class5AiAgentTestCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5AiAgentTestInput"},"example":{"account_id":1,"agent_id":1,"name":"Example Name","conversation":"Sample conversation text content","criteria":"Sample criteria text content"}}}}}},"/api/cp/class5/ai-agent-test/{id}":{"get":{"tags":["Class 5 AI Agent Test"],"summary":"Read","description":"Retrieve a single Class 5 AI Agent Test record by ID.","operationId":"class5AiAgentTestRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5AiAgentTest"},"example":{"id":12345,"account_id":1,"agent_id":1,"name":"Example Name","conversation":"Sample conversation text content","criteria":"Sample criteria text content"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Class 5 AI Agent Test"],"summary":"Update","description":"Update an existing Class 5 AI Agent Test record by ID.","operationId":"class5AiAgentTestUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5AiAgentTestInput"},"example":{"account_id":1,"agent_id":1,"name":"Example Name","conversation":"Sample conversation text content","criteria":"Sample criteria text content"}}}}},"delete":{"tags":["Class 5 AI Agent Test"],"summary":"Delete","description":"Delete a Class 5 AI Agent Test record by ID.","operationId":"class5AiAgentTestDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/class5/ai-agent-test/{id}/run":{"get":{"tags":["Class 5 AI Agent Test"],"summary":"Run Test","description":"Run Test","operationId":"class5AiAgentTestRunTest","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5AiAgentTest"},"example":{"id":12345,"account_id":1,"agent_id":1,"name":"Example Name","conversation":"Sample conversation text content","criteria":"Sample criteria text content"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/class5/ai-agent/options":{"get":{"tags":["Class 5 - AI Agent"],"summary":"Options","description":"Options","operationId":"class5AiAgentOptions","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5AiAgent"},"example":{"id":12345,"account_id":1,"company_id":1,"app_id":1,"dest":"example_dest","host":"example_host","pbx_server":"example_pbx_server","name":"Example Name","prompt":"Sample prompt text content","platform":"openai","provider":"example_provider","model":"example_model","transcriber":"example_transcriber","transcriber_model":"example_transcriber_model","transcriber_silence_threshold":99.99,"transcriber_language":"example_transcriber_language","tts":"example_tts","voice":"example_voice","first_message":"example_first_message","endpoint_id":1,"vad":1,"early_end_turn_threshold":99.99,"end_turn_threshold":99.99,"temperature":99.99,"built_in_functions":"example_built_in_functions","end_call_phrases":"example_end_call_phrases","interrupt_delay":99.99,"guard_rails":"example_guard_rails","filler_words":"example_filler_words","min_filler_word_delay":99.99,"office_background_volume":99.99,"flags":"ASYNC_GUARD_RAILS","llm_timeout":99.99,"llm_retries":1,"amd_keywords":"example_amd_keywords","vars":"example_vars","transcriber_timeout":1,"tool_call_allow_list":"example_tool_call_allow_list","precache_phrases":"example_precache_phrases","first_task_id":1,"kb_id":1,"asr_provider_config_id":1,"llm_provider_config_id":1,"tts_provider_config_id":1,"s2s_provider_config_id":1,"mcp_servers":"Sample mcp_servers text content"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/class5/ai-agent/{id}":{"get":{"tags":["Class 5 - AI Agent"],"summary":"Read","description":"Retrieve a single Class 5 - AI Agent record by ID.","operationId":"class5AiAgentRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5AiAgent"},"example":{"id":12345,"account_id":1,"company_id":1,"app_id":1,"dest":"example_dest","host":"example_host","pbx_server":"example_pbx_server","name":"Example Name","prompt":"Sample prompt text content","platform":"openai","provider":"example_provider","model":"example_model","transcriber":"example_transcriber","transcriber_model":"example_transcriber_model","transcriber_silence_threshold":99.99,"transcriber_language":"example_transcriber_language","tts":"example_tts","voice":"example_voice","first_message":"example_first_message","endpoint_id":1,"vad":1,"early_end_turn_threshold":99.99,"end_turn_threshold":99.99,"temperature":99.99,"built_in_functions":"example_built_in_functions","end_call_phrases":"example_end_call_phrases","interrupt_delay":99.99,"guard_rails":"example_guard_rails","filler_words":"example_filler_words","min_filler_word_delay":99.99,"office_background_volume":99.99,"flags":"ASYNC_GUARD_RAILS","llm_timeout":99.99,"llm_retries":1,"amd_keywords":"example_amd_keywords","vars":"example_vars","transcriber_timeout":1,"tool_call_allow_list":"example_tool_call_allow_list","precache_phrases":"example_precache_phrases","first_task_id":1,"kb_id":1,"asr_provider_config_id":1,"llm_provider_config_id":1,"tts_provider_config_id":1,"s2s_provider_config_id":1,"mcp_servers":"Sample mcp_servers text content"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Class 5 - AI Agent"],"summary":"Update","description":"Update an existing Class 5 - AI Agent record by ID.","operationId":"class5AiAgentUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5AiAgentInput"},"example":{"account_id":1,"company_id":1,"app_id":1,"dest":"example_dest","host":"example_host","pbx_server":"example_pbx_server","name":"Example Name","prompt":"Sample prompt text content","platform":"openai","provider":"example_provider","model":"example_model","transcriber":"example_transcriber","transcriber_model":"example_transcriber_model","transcriber_silence_threshold":99.99,"transcriber_language":"example_transcriber_language","tts":"example_tts","voice":"example_voice","first_message":"example_first_message","endpoint_id":1,"vad":1,"early_end_turn_threshold":99.99,"end_turn_threshold":99.99,"temperature":99.99,"built_in_functions":"example_built_in_functions","end_call_phrases":"example_end_call_phrases","interrupt_delay":99.99,"guard_rails":"example_guard_rails","filler_words":"example_filler_words","min_filler_word_delay":99.99,"office_background_volume":99.99,"flags":"ASYNC_GUARD_RAILS","llm_timeout":99.99,"llm_retries":1,"amd_keywords":"example_amd_keywords","vars":"example_vars","transcriber_timeout":1,"tool_call_allow_list":"example_tool_call_allow_list","precache_phrases":"example_precache_phrases","first_task_id":1,"kb_id":1,"asr_provider_config_id":1,"llm_provider_config_id":1,"tts_provider_config_id":1,"s2s_provider_config_id":1,"mcp_servers":"Sample mcp_servers text content"}}}}},"delete":{"tags":["Class 5 - AI Agent"],"summary":"Delete","description":"Delete a Class 5 - AI Agent record by ID.","operationId":"class5AiAgentDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/class5/ai-agent/{id}/chat":{"socket":{"tags":["Class 5 - AI Agent"],"summary":"Chat Socket","description":"Chat Socket","operationId":"class5AiAgentChatSocket","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/class5/app":{"get":{"tags":["Class 5 App"],"summary":"List","description":"Retrieve a paginated list of Class 5 App records. Supports filtering, sorting, and search.","operationId":"class5AppList","parameters":[{"in":"query","name":"app_type","description":"Filter by App Type","required":false,"schema":{"type":"string","enum":["connexml","legacy","callflow"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/class5App"}},"example":[{"id":12345,"account_id":1,"company_id":1,"name":"Example Name","app_type":"connexml","dest":"example_dest","allow":"example_allow","deny":"example_deny","data":"Sample data text content","pbx_server":"example_pbx_server","xml":"Sample xml text content"},{"id":12345,"account_id":1,"company_id":1,"name":"Example Name","app_type":"connexml","dest":"example_dest","allow":"example_allow","deny":"example_deny","data":"Sample data text content","pbx_server":"example_pbx_server","xml":"Sample xml text content"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Class 5 App"],"summary":"Create","description":"Create a new Class 5 App record.","operationId":"class5AppCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5AppInput"},"example":{"account_id":1,"company_id":1,"name":"Example Name","app_type":"connexml","dest":"example_dest","allow":"example_allow","deny":"example_deny","data":"Sample data text content","pbx_server":"example_pbx_server","xml":"Sample xml text content"}}}}}},"/api/cp/class5/app/{id}":{"get":{"tags":["Class 5 App"],"summary":"Read","description":"Retrieve a single Class 5 App record by ID.","operationId":"class5AppRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5App"},"example":{"id":12345,"account_id":1,"company_id":1,"name":"Example Name","app_type":"connexml","dest":"example_dest","allow":"example_allow","deny":"example_deny","data":"Sample data text content","pbx_server":"example_pbx_server","xml":"Sample xml text content"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Class 5 App"],"summary":"Update","description":"Update an existing Class 5 App record by ID.","operationId":"class5AppUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5AppInput"},"example":{"account_id":1,"company_id":1,"name":"Example Name","app_type":"connexml","dest":"example_dest","allow":"example_allow","deny":"example_deny","data":"Sample data text content","pbx_server":"example_pbx_server","xml":"Sample xml text content"}}}}},"delete":{"tags":["Class 5 App"],"summary":"Delete","description":"Delete a Class 5 App record by ID.","operationId":"class5AppDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/class5/audio":{"get":{"tags":["Class 5 Audio"],"summary":"List","description":"Retrieve a paginated list of Class 5 Audio records. Supports filtering, sorting, and search.","operationId":"class5AudioList","parameters":[{"in":"query","name":"category","description":"Filter by Category","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/class5Audio"}},"example":[{"category":"example_category","name":"Example Name"},{"category":"example_category","name":"Example Name"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/class5/call-center":{"get":{"tags":["Class 5 Call Center"],"summary":"List","description":"Retrieve a paginated list of Class 5 Call Center records. Supports filtering, sorting, and search.","operationId":"class5CallCenterList","parameters":[{"in":"query","name":"strategy","description":"Filter by Strategy","required":false,"schema":{"type":"string","enum":["ring-all","longest-idle-agent","round-robin","top-down","agent-with-least-talk-time","agent-with-fewest-calls","sequentially-by-agent-order","random","ring-progressively"]}},{"in":"query","name":"time_base_score","description":"Filter by Time Base Score","required":false,"schema":{"type":"string","enum":["system","queue"]}},{"in":"query","name":"agent_no_answer_status","description":"Filter by Agent No Answer Status","required":false,"schema":{"type":"string","enum":["Available","Available (On Demand"]}},{"in":"query","name":"failover_dest_type","description":"Filter by Failover Dest Type","required":false,"schema":{"type":"string","enum":["internal","external"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/class5CallCenter"}},"example":[{"id":12345,"account_id":1,"company_id":1,"pbx_server":"example_pbx_server","c4_server":"example_c4_server","name":"Example Name","dest":"example_dest","strategy":"ring-all","moh_sound":"example_moh_sound","record_template":"example_record_template","time_base_score":"system","max_wait_time":123,"max_wait_time_with_no_agent":123,"max_wait_time_with_no_agent_time_reached":123,"agent_no_answer_status":"Available","tier_rules_apply":1,"tier_rule_wait_second":123,"tier_rule_wait_multiply_level":1,"tier_rule_no_agent_no_wait":1,"discard_abandoned_after":123,"abandoned_resume_allowed":1,"failover_dest":"example_failover_dest","failover_dest_type":"internal","created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"},{"id":12345,"account_id":1,"company_id":1,"pbx_server":"example_pbx_server","c4_server":"example_c4_server","name":"Example Name","dest":"example_dest","strategy":"ring-all","moh_sound":"example_moh_sound","record_template":"example_record_template","time_base_score":"system","max_wait_time":123,"max_wait_time_with_no_agent":123,"max_wait_time_with_no_agent_time_reached":123,"agent_no_answer_status":"Available","tier_rules_apply":1,"tier_rule_wait_second":123,"tier_rule_wait_multiply_level":1,"tier_rule_no_agent_no_wait":1,"discard_abandoned_after":123,"abandoned_resume_allowed":1,"failover_dest":"example_failover_dest","failover_dest_type":"internal","created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Class 5 Call Center"],"summary":"Create","description":"Create a new Class 5 Call Center record.","operationId":"class5CallCenterCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5CallCenterInput"},"example":{"account_id":1,"company_id":1,"pbx_server":"example_pbx_server","c4_server":"example_c4_server","name":"Example Name","dest":"example_dest","strategy":"ring-all","moh_sound":"example_moh_sound","record_template":"example_record_template","time_base_score":"system","max_wait_time":123,"max_wait_time_with_no_agent":123,"max_wait_time_with_no_agent_time_reached":123,"agent_no_answer_status":"Available","tier_rules_apply":1,"tier_rule_wait_second":123,"tier_rule_wait_multiply_level":1,"tier_rule_no_agent_no_wait":1,"discard_abandoned_after":123,"abandoned_resume_allowed":1,"failover_dest":"example_failover_dest","failover_dest_type":"internal"}}}}}},"/api/cp/class5/call-center-consumer":{"get":{"tags":["Class 5 Call Center Consumer"],"summary":"List","description":"Retrieve a paginated list of Class 5 Call Center Consumer records. Supports filtering, sorting, and search.","operationId":"class5CallCenterConsumerList","parameters":[{"in":"query","name":"type","description":"Filter by Type","required":false,"schema":{"type":"string","enum":["callback","uuid-standby"]}},{"in":"query","name":"status","description":"Filter by Status","required":false,"schema":{"type":"string","enum":["Available","Available (On Demand"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/class5CallCenterConsumer"}},"example":[{"id":12345,"call_center_id":1,"sip_user_id":1,"level":123,"position":123,"type":"callback","status":"Available","max_no_answer":123,"wrap_up_time":123,"reject_delay_time":123,"busy_delay_time":123,"no_answer_delay_time":123,"ring_timeout":123,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"},{"id":12345,"call_center_id":1,"sip_user_id":1,"level":123,"position":123,"type":"callback","status":"Available","max_no_answer":123,"wrap_up_time":123,"reject_delay_time":123,"busy_delay_time":123,"no_answer_delay_time":123,"ring_timeout":123,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Class 5 Call Center Consumer"],"summary":"Create","description":"Create a new Class 5 Call Center Consumer record.","operationId":"class5CallCenterConsumerCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5CallCenterConsumerInput"},"example":{"call_center_id":1,"sip_user_id":1,"level":123,"position":123,"type":"callback","status":"Available","max_no_answer":123,"wrap_up_time":123,"reject_delay_time":123,"busy_delay_time":123,"no_answer_delay_time":123,"ring_timeout":123}}}}}},"/api/cp/class5/call-center-consumer/{id}":{"get":{"tags":["Class 5 Call Center Consumer"],"summary":"Read","description":"Retrieve a single Class 5 Call Center Consumer record by ID.","operationId":"class5CallCenterConsumerRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5CallCenterConsumer"},"example":{"id":12345,"call_center_id":1,"sip_user_id":1,"level":123,"position":123,"type":"callback","status":"Available","max_no_answer":123,"wrap_up_time":123,"reject_delay_time":123,"busy_delay_time":123,"no_answer_delay_time":123,"ring_timeout":123,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Class 5 Call Center Consumer"],"summary":"Update","description":"Update an existing Class 5 Call Center Consumer record by ID.","operationId":"class5CallCenterConsumerUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5CallCenterConsumerInput"},"example":{"call_center_id":1,"sip_user_id":1,"level":123,"position":123,"type":"callback","status":"Available","max_no_answer":123,"wrap_up_time":123,"reject_delay_time":123,"busy_delay_time":123,"no_answer_delay_time":123,"ring_timeout":123}}}}},"delete":{"tags":["Class 5 Call Center Consumer"],"summary":"Delete","description":"Delete a Class 5 Call Center Consumer record by ID.","operationId":"class5CallCenterConsumerDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/class5/call-center-consumer/{id}/status":{"get":{"tags":["Class 5 Call Center Consumer"],"summary":"Get Call Center Consumer Status","description":"Get Call Center Consumer Status","operationId":"class5CallCenterConsumerGetCallCenterConsumerStatus","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5CallCenterConsumer"},"example":{"id":12345,"call_center_id":1,"sip_user_id":1,"level":123,"position":123,"type":"callback","status":"Available","max_no_answer":123,"wrap_up_time":123,"reject_delay_time":123,"busy_delay_time":123,"no_answer_delay_time":123,"ring_timeout":123,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Class 5 Call Center Consumer"],"summary":"Set Status","description":"Set Status","operationId":"class5CallCenterConsumerSetStatus","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5CallCenterConsumerInput"},"example":{"call_center_id":1,"sip_user_id":1,"level":123,"position":123,"type":"callback","status":"Available","max_no_answer":123,"wrap_up_time":123,"reject_delay_time":123,"busy_delay_time":123,"no_answer_delay_time":123,"ring_timeout":123}}}}}},"/api/cp/class5/call-center/status":{"get":{"tags":["Class 5 Call Center"],"summary":"Get Call Center Status","description":"Get Call Center Status","operationId":"class5CallCenterGetCallCenterStatus","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5CallCenter"},"example":{"id":12345,"account_id":1,"company_id":1,"pbx_server":"example_pbx_server","c4_server":"example_c4_server","name":"Example Name","dest":"example_dest","strategy":"ring-all","moh_sound":"example_moh_sound","record_template":"example_record_template","time_base_score":"system","max_wait_time":123,"max_wait_time_with_no_agent":123,"max_wait_time_with_no_agent_time_reached":123,"agent_no_answer_status":"Available","tier_rules_apply":1,"tier_rule_wait_second":123,"tier_rule_wait_multiply_level":1,"tier_rule_no_agent_no_wait":1,"discard_abandoned_after":123,"abandoned_resume_allowed":1,"failover_dest":"example_failover_dest","failover_dest_type":"internal","created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/class5/call-center/{id}":{"get":{"tags":["Class 5 Call Center"],"summary":"Read","description":"Retrieve a single Class 5 Call Center record by ID.","operationId":"class5CallCenterRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5CallCenter"},"example":{"id":12345,"account_id":1,"company_id":1,"pbx_server":"example_pbx_server","c4_server":"example_c4_server","name":"Example Name","dest":"example_dest","strategy":"ring-all","moh_sound":"example_moh_sound","record_template":"example_record_template","time_base_score":"system","max_wait_time":123,"max_wait_time_with_no_agent":123,"max_wait_time_with_no_agent_time_reached":123,"agent_no_answer_status":"Available","tier_rules_apply":1,"tier_rule_wait_second":123,"tier_rule_wait_multiply_level":1,"tier_rule_no_agent_no_wait":1,"discard_abandoned_after":123,"abandoned_resume_allowed":1,"failover_dest":"example_failover_dest","failover_dest_type":"internal","created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Class 5 Call Center"],"summary":"Update","description":"Update an existing Class 5 Call Center record by ID.","operationId":"class5CallCenterUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5CallCenterInput"},"example":{"account_id":1,"company_id":1,"pbx_server":"example_pbx_server","c4_server":"example_c4_server","name":"Example Name","dest":"example_dest","strategy":"ring-all","moh_sound":"example_moh_sound","record_template":"example_record_template","time_base_score":"system","max_wait_time":123,"max_wait_time_with_no_agent":123,"max_wait_time_with_no_agent_time_reached":123,"agent_no_answer_status":"Available","tier_rules_apply":1,"tier_rule_wait_second":123,"tier_rule_wait_multiply_level":1,"tier_rule_no_agent_no_wait":1,"discard_abandoned_after":123,"abandoned_resume_allowed":1,"failover_dest":"example_failover_dest","failover_dest_type":"internal"}}}}},"delete":{"tags":["Class 5 Call Center"],"summary":"Delete","description":"Delete a Class 5 Call Center record by ID.","operationId":"class5CallCenterDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/class5/call-center/{id}/members":{"get":{"tags":["Class 5 Call Center"],"summary":"Members","description":"Members","operationId":"class5CallCenterMembers","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5CallCenter"},"example":{"id":12345,"account_id":1,"company_id":1,"pbx_server":"example_pbx_server","c4_server":"example_c4_server","name":"Example Name","dest":"example_dest","strategy":"ring-all","moh_sound":"example_moh_sound","record_template":"example_record_template","time_base_score":"system","max_wait_time":123,"max_wait_time_with_no_agent":123,"max_wait_time_with_no_agent_time_reached":123,"agent_no_answer_status":"Available","tier_rules_apply":1,"tier_rule_wait_second":123,"tier_rule_wait_multiply_level":1,"tier_rule_no_agent_no_wait":1,"discard_abandoned_after":123,"abandoned_resume_allowed":1,"failover_dest":"example_failover_dest","failover_dest_type":"internal","created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/class5/call-center/{id}/reload":{"post":{"tags":["Class 5 Call Center"],"summary":"Reload","description":"Reload","operationId":"class5CallCenterReload","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5CallCenterInput"},"example":{"account_id":1,"company_id":1,"pbx_server":"example_pbx_server","c4_server":"example_c4_server","name":"Example Name","dest":"example_dest","strategy":"ring-all","moh_sound":"example_moh_sound","record_template":"example_record_template","time_base_score":"system","max_wait_time":123,"max_wait_time_with_no_agent":123,"max_wait_time_with_no_agent_time_reached":123,"agent_no_answer_status":"Available","tier_rules_apply":1,"tier_rule_wait_second":123,"tier_rule_wait_multiply_level":1,"tier_rule_no_agent_no_wait":1,"discard_abandoned_after":123,"abandoned_resume_allowed":1,"failover_dest":"example_failover_dest","failover_dest_type":"internal"}}}}}},"/api/cp/class5/call-center/{id}/status":{"get":{"tags":["Class 5 Call Center"],"summary":"Get Call Center Status","description":"Get Call Center Status","operationId":"class5CallCenterGetCallCenterStatus","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5CallCenter"},"example":{"id":12345,"account_id":1,"company_id":1,"pbx_server":"example_pbx_server","c4_server":"example_c4_server","name":"Example Name","dest":"example_dest","strategy":"ring-all","moh_sound":"example_moh_sound","record_template":"example_record_template","time_base_score":"system","max_wait_time":123,"max_wait_time_with_no_agent":123,"max_wait_time_with_no_agent_time_reached":123,"agent_no_answer_status":"Available","tier_rules_apply":1,"tier_rule_wait_second":123,"tier_rule_wait_multiply_level":1,"tier_rule_no_agent_no_wait":1,"discard_abandoned_after":123,"abandoned_resume_allowed":1,"failover_dest":"example_failover_dest","failover_dest_type":"internal","created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/class5/conference":{"get":{"tags":["Class 5 Conference"],"summary":"List","description":"Retrieve a paginated list of Class 5 Conference records. Supports filtering, sorting, and search.","operationId":"class5ConferenceList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/class5Conference"}},"example":[{"id":12345,"account_id":1,"customer_id":1,"name":"Example Name","dest":"example_dest","pin":"example_pin","moderator_pin":"example_moderator_pin","quality":"example_quality","max_members":123,"pbx_server":"example_pbx_server"},{"id":12345,"account_id":1,"customer_id":1,"name":"Example Name","dest":"example_dest","pin":"example_pin","moderator_pin":"example_moderator_pin","quality":"example_quality","max_members":123,"pbx_server":"example_pbx_server"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Class 5 Conference"],"summary":"Create","description":"Create a new Class 5 Conference record.","operationId":"class5ConferenceCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5ConferenceInput"},"example":{"account_id":1,"customer_id":1,"name":"Example Name","dest":"example_dest","pin":"example_pin","moderator_pin":"example_moderator_pin","quality":"example_quality","max_members":123,"pbx_server":"example_pbx_server"}}}}}},"/api/cp/class5/conference/{id}":{"get":{"tags":["Class 5 Conference"],"summary":"Read","description":"Retrieve a single Class 5 Conference record by ID.","operationId":"class5ConferenceRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5Conference"},"example":{"id":12345,"account_id":1,"customer_id":1,"name":"Example Name","dest":"example_dest","pin":"example_pin","moderator_pin":"example_moderator_pin","quality":"example_quality","max_members":123,"pbx_server":"example_pbx_server"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Class 5 Conference"],"summary":"Update","description":"Update an existing Class 5 Conference record by ID.","operationId":"class5ConferenceUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5ConferenceInput"},"example":{"account_id":1,"customer_id":1,"name":"Example Name","dest":"example_dest","pin":"example_pin","moderator_pin":"example_moderator_pin","quality":"example_quality","max_members":123,"pbx_server":"example_pbx_server"}}}}},"delete":{"tags":["Class 5 Conference"],"summary":"Delete","description":"Delete a Class 5 Conference record by ID.","operationId":"class5ConferenceDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/class5/directory":{"get":{"tags":["Class 5 Directory"],"summary":"List","description":"Retrieve a paginated list of Class 5 Directory records. Supports filtering, sorting, and search.","operationId":"class5DirectoryList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/class5Directory"}}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/class5/directory/unallocated":{"get":{"tags":["Class 5 Directory"],"summary":"Unallocated","description":"Unallocated","operationId":"class5DirectoryUnallocated","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5Directory"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/class5/group":{"get":{"tags":["Class 5 Group"],"summary":"List","description":"Retrieve a paginated list of Class 5 Group records. Supports filtering, sorting, and search.","operationId":"class5GroupList","parameters":[{"in":"query","name":"distribution_method","description":"Filter by Distribution Method","required":false,"schema":{"type":"string","enum":["parallel","sequential","queue"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/class5Group"}},"example":[{"id":12345,"account_id":1,"customer_id":1,"name":"Example Name","dest":"example_dest","agent_login_dest":"example_agent_login_dest","agent_logout_dest":"example_agent_logout_dest","agent_offhook_dest":"example_agent_offhook_dest","distribution_method":"parallel","server_affinity":"example_server_affinity","on_hold_music":"example_on_hold_music","join_message":"example_join_message","chime_list":"example_chime_list","chime_interval":1,"pbx_server":"example_pbx_server"},{"id":12345,"account_id":1,"customer_id":1,"name":"Example Name","dest":"example_dest","agent_login_dest":"example_agent_login_dest","agent_logout_dest":"example_agent_logout_dest","agent_offhook_dest":"example_agent_offhook_dest","distribution_method":"parallel","server_affinity":"example_server_affinity","on_hold_music":"example_on_hold_music","join_message":"example_join_message","chime_list":"example_chime_list","chime_interval":1,"pbx_server":"example_pbx_server"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Class 5 Group"],"summary":"Create","description":"Create a new Class 5 Group record.","operationId":"class5GroupCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5GroupInput"},"example":{"account_id":1,"customer_id":1,"name":"Example Name","dest":"example_dest","agent_login_dest":"example_agent_login_dest","agent_logout_dest":"example_agent_logout_dest","agent_offhook_dest":"example_agent_offhook_dest","distribution_method":"parallel","server_affinity":"example_server_affinity","on_hold_music":"example_on_hold_music","join_message":"example_join_message","chime_list":"example_chime_list","chime_interval":1,"pbx_server":"example_pbx_server"}}}}}},"/api/cp/class5/group-member":{"get":{"tags":["Class 5 Group Member"],"summary":"List","description":"Retrieve a paginated list of Class 5 Group Member records. Supports filtering, sorting, and search.","operationId":"class5GroupMemberList","parameters":[{"in":"query","name":"destination_type","description":"Filter by Destination Type","required":false,"schema":{"type":"string","enum":["external","internal","uri","user"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/class5GroupMember"}},"example":[{"id":12345,"group_id":1,"destination":"example_destination","destination_type":"external","ring_timeout":1,"idx":1,"weight":1},{"id":12345,"group_id":1,"destination":"example_destination","destination_type":"external","ring_timeout":1,"idx":1,"weight":1}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Class 5 Group Member"],"summary":"Create","description":"Create a new Class 5 Group Member record.","operationId":"class5GroupMemberCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5GroupMemberInput"},"example":{"group_id":1,"destination":"example_destination","destination_type":"external","ring_timeout":1,"idx":1,"weight":1}}}}}},"/api/cp/class5/group-member/{id}":{"get":{"tags":["Class 5 Group Member"],"summary":"Read","description":"Retrieve a single Class 5 Group Member record by ID.","operationId":"class5GroupMemberRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5GroupMember"},"example":{"id":12345,"group_id":1,"destination":"example_destination","destination_type":"external","ring_timeout":1,"idx":1,"weight":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Class 5 Group Member"],"summary":"Update","description":"Update an existing Class 5 Group Member record by ID.","operationId":"class5GroupMemberUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5GroupMemberInput"},"example":{"group_id":1,"destination":"example_destination","destination_type":"external","ring_timeout":1,"idx":1,"weight":1}}}}},"delete":{"tags":["Class 5 Group Member"],"summary":"Delete","description":"Delete a Class 5 Group Member record by ID.","operationId":"class5GroupMemberDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/class5/group/{id}":{"get":{"tags":["Class 5 Group"],"summary":"Read","description":"Retrieve a single Class 5 Group record by ID.","operationId":"class5GroupRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5Group"},"example":{"id":12345,"account_id":1,"customer_id":1,"name":"Example Name","dest":"example_dest","agent_login_dest":"example_agent_login_dest","agent_logout_dest":"example_agent_logout_dest","agent_offhook_dest":"example_agent_offhook_dest","distribution_method":"parallel","server_affinity":"example_server_affinity","on_hold_music":"example_on_hold_music","join_message":"example_join_message","chime_list":"example_chime_list","chime_interval":1,"pbx_server":"example_pbx_server"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Class 5 Group"],"summary":"Update","description":"Update an existing Class 5 Group record by ID.","operationId":"class5GroupUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5GroupInput"},"example":{"account_id":1,"customer_id":1,"name":"Example Name","dest":"example_dest","agent_login_dest":"example_agent_login_dest","agent_logout_dest":"example_agent_logout_dest","agent_offhook_dest":"example_agent_offhook_dest","distribution_method":"parallel","server_affinity":"example_server_affinity","on_hold_music":"example_on_hold_music","join_message":"example_join_message","chime_list":"example_chime_list","chime_interval":1,"pbx_server":"example_pbx_server"}}}}},"delete":{"tags":["Class 5 Group"],"summary":"Delete","description":"Delete a Class 5 Group record by ID.","operationId":"class5GroupDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/class5/ivr":{"get":{"tags":["Class 5 IVR"],"summary":"List","description":"Retrieve a paginated list of Class 5 IVR records. Supports filtering, sorting, and search.","operationId":"class5IvrList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/class5Ivr"}},"example":[{"id":12345,"account_id":1,"customer_id":1,"dest":"example_dest","name":"Example Name","invalid_file":"example_invalid_file","file":"example_file","key_0_destination":"example_key_0_destination","key_0_destination_type":"example_key_0_destination_type","key_1_destination":"example_key_1_destination","key_1_destination_type":"example_key_1_destination_type","key_2_destination":"example_key_2_destination","key_2_destination_type":"example_key_2_destination_type","key_3_destination":"example_key_3_destination","key_3_destination_type":"example_key_3_destination_type","key_4_destination":"example_key_4_destination","key_4_destination_type":"example_key_4_destination_type","key_5_destination":"example_key_5_destination","key_5_destination_type":"example_key_5_destination_type","key_6_destination":"example_key_6_destination","key_6_destination_type":"example_key_6_destination_type","key_7_destination":"example_key_7_destination","key_7_destination_type":"example_key_7_destination_type","key_8_destination":"example_key_8_destination","key_8_destination_type":"example_key_8_destination_type","key_9_destination":"example_key_9_destination","key_9_destination_type":"example_key_9_destination_type","key_plus_destination":"example_key_plus_destination","key_plus_destination_type":"example_key_plus_destination_type","key_hash_destination":"example_key_hash_destination","key_hash_destination_type":"example_key_hash_destination_type","pbx_server":"example_pbx_server","direct_extension_dial":1},{"id":12345,"account_id":1,"customer_id":1,"dest":"example_dest","name":"Example Name","invalid_file":"example_invalid_file","file":"example_file","key_0_destination":"example_key_0_destination","key_0_destination_type":"example_key_0_destination_type","key_1_destination":"example_key_1_destination","key_1_destination_type":"example_key_1_destination_type","key_2_destination":"example_key_2_destination","key_2_destination_type":"example_key_2_destination_type","key_3_destination":"example_key_3_destination","key_3_destination_type":"example_key_3_destination_type","key_4_destination":"example_key_4_destination","key_4_destination_type":"example_key_4_destination_type","key_5_destination":"example_key_5_destination","key_5_destination_type":"example_key_5_destination_type","key_6_destination":"example_key_6_destination","key_6_destination_type":"example_key_6_destination_type","key_7_destination":"example_key_7_destination","key_7_destination_type":"example_key_7_destination_type","key_8_destination":"example_key_8_destination","key_8_destination_type":"example_key_8_destination_type","key_9_destination":"example_key_9_destination","key_9_destination_type":"example_key_9_destination_type","key_plus_destination":"example_key_plus_destination","key_plus_destination_type":"example_key_plus_destination_type","key_hash_destination":"example_key_hash_destination","key_hash_destination_type":"example_key_hash_destination_type","pbx_server":"example_pbx_server","direct_extension_dial":1}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Class 5 IVR"],"summary":"Create","description":"Create a new Class 5 IVR record.","operationId":"class5IvrCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5IvrInput"},"example":{"account_id":1,"customer_id":1,"dest":"example_dest","name":"Example Name","invalid_file":"example_invalid_file","file":"example_file","key_0_destination":"example_key_0_destination","key_0_destination_type":"example_key_0_destination_type","key_1_destination":"example_key_1_destination","key_1_destination_type":"example_key_1_destination_type","key_2_destination":"example_key_2_destination","key_2_destination_type":"example_key_2_destination_type","key_3_destination":"example_key_3_destination","key_3_destination_type":"example_key_3_destination_type","key_4_destination":"example_key_4_destination","key_4_destination_type":"example_key_4_destination_type","key_5_destination":"example_key_5_destination","key_5_destination_type":"example_key_5_destination_type","key_6_destination":"example_key_6_destination","key_6_destination_type":"example_key_6_destination_type","key_7_destination":"example_key_7_destination","key_7_destination_type":"example_key_7_destination_type","key_8_destination":"example_key_8_destination","key_8_destination_type":"example_key_8_destination_type","key_9_destination":"example_key_9_destination","key_9_destination_type":"example_key_9_destination_type","key_plus_destination":"example_key_plus_destination","key_plus_destination_type":"example_key_plus_destination_type","key_hash_destination":"example_key_hash_destination","key_hash_destination_type":"example_key_hash_destination_type","pbx_server":"example_pbx_server","direct_extension_dial":1}}}}}},"/api/cp/class5/ivr/{id}":{"get":{"tags":["Class 5 IVR"],"summary":"Read","description":"Retrieve a single Class 5 IVR record by ID.","operationId":"class5IvrRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5Ivr"},"example":{"id":12345,"account_id":1,"customer_id":1,"dest":"example_dest","name":"Example Name","invalid_file":"example_invalid_file","file":"example_file","key_0_destination":"example_key_0_destination","key_0_destination_type":"example_key_0_destination_type","key_1_destination":"example_key_1_destination","key_1_destination_type":"example_key_1_destination_type","key_2_destination":"example_key_2_destination","key_2_destination_type":"example_key_2_destination_type","key_3_destination":"example_key_3_destination","key_3_destination_type":"example_key_3_destination_type","key_4_destination":"example_key_4_destination","key_4_destination_type":"example_key_4_destination_type","key_5_destination":"example_key_5_destination","key_5_destination_type":"example_key_5_destination_type","key_6_destination":"example_key_6_destination","key_6_destination_type":"example_key_6_destination_type","key_7_destination":"example_key_7_destination","key_7_destination_type":"example_key_7_destination_type","key_8_destination":"example_key_8_destination","key_8_destination_type":"example_key_8_destination_type","key_9_destination":"example_key_9_destination","key_9_destination_type":"example_key_9_destination_type","key_plus_destination":"example_key_plus_destination","key_plus_destination_type":"example_key_plus_destination_type","key_hash_destination":"example_key_hash_destination","key_hash_destination_type":"example_key_hash_destination_type","pbx_server":"example_pbx_server","direct_extension_dial":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Class 5 IVR"],"summary":"Update","description":"Update an existing Class 5 IVR record by ID.","operationId":"class5IvrUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/class5IvrInput"},"example":{"account_id":1,"customer_id":1,"dest":"example_dest","name":"Example Name","invalid_file":"example_invalid_file","file":"example_file","key_0_destination":"example_key_0_destination","key_0_destination_type":"example_key_0_destination_type","key_1_destination":"example_key_1_destination","key_1_destination_type":"example_key_1_destination_type","key_2_destination":"example_key_2_destination","key_2_destination_type":"example_key_2_destination_type","key_3_destination":"example_key_3_destination","key_3_destination_type":"example_key_3_destination_type","key_4_destination":"example_key_4_destination","key_4_destination_type":"example_key_4_destination_type","key_5_destination":"example_key_5_destination","key_5_destination_type":"example_key_5_destination_type","key_6_destination":"example_key_6_destination","key_6_destination_type":"example_key_6_destination_type","key_7_destination":"example_key_7_destination","key_7_destination_type":"example_key_7_destination_type","key_8_destination":"example_key_8_destination","key_8_destination_type":"example_key_8_destination_type","key_9_destination":"example_key_9_destination","key_9_destination_type":"example_key_9_destination_type","key_plus_destination":"example_key_plus_destination","key_plus_destination_type":"example_key_plus_destination_type","key_hash_destination":"example_key_hash_destination","key_hash_destination_type":"example_key_hash_destination_type","pbx_server":"example_pbx_server","direct_extension_dial":1}}}}},"delete":{"tags":["Class 5 IVR"],"summary":"Delete","description":"Delete a Class 5 IVR record by ID.","operationId":"class5IvrDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/class5/kb":{"get":{"tags":["Knowledge Base"],"summary":"List","description":"Retrieve a paginated list of Knowledge Base records. Supports filtering, sorting, and search.","operationId":"knowledgeBaseList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Knowledge Base"],"summary":"Create","description":"Create a new Knowledge Base record.","operationId":"knowledgeBaseCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/class5/kb-source":{"get":{"tags":["Knowledge Base Source"],"summary":"List","description":"Retrieve a paginated list of Knowledge Base Source records. Supports filtering, sorting, and search.","operationId":"knowledgeBaseSourceList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Knowledge Base Source"],"summary":"Create","description":"Create a new Knowledge Base Source record.","operationId":"knowledgeBaseSourceCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/class5/kb-source/{id}":{"get":{"tags":["Knowledge Base Source"],"summary":"Read","description":"Retrieve a single Knowledge Base Source record by ID.","operationId":"knowledgeBaseSourceRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Knowledge Base Source"],"summary":"Update","description":"Update an existing Knowledge Base Source record by ID.","operationId":"knowledgeBaseSourceUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"delete":{"tags":["Knowledge Base Source"],"summary":"Delete","description":"Delete a Knowledge Base Source record by ID.","operationId":"knowledgeBaseSourceDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/class5/kb-source/{id}/index":{"post":{"tags":["Knowledge Base Source"],"summary":"Index","description":"Index","operationId":"knowledgeBaseSourceIndex","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/class5/kb/{id}":{"get":{"tags":["Knowledge Base"],"summary":"Read","description":"Retrieve a single Knowledge Base record by ID.","operationId":"knowledgeBaseRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Knowledge Base"],"summary":"Update","description":"Update an existing Knowledge Base record by ID.","operationId":"knowledgeBaseUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"delete":{"tags":["Knowledge Base"],"summary":"Delete","description":"Delete a Knowledge Base record by ID.","operationId":"knowledgeBaseDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/class5/system-dialplan":{"get":{"tags":["Class 5 System Dialplan"],"summary":"List","description":"Retrieve a paginated list of Class 5 System Dialplan records. Supports filtering, sorting, and search.","operationId":"class5SystemDialplanList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/class5SystemDialplan"}},"example":[{"id":12345,"account_id":1,"name":"Example Name"},{"id":12345,"account_id":1,"name":"Example Name"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/cli":{"get":{"tags":["Cli"],"summary":"List","description":"Retrieve a paginated list of Cli records. Supports filtering, sorting, and search.","operationId":"cliList","parameters":[{"in":"query","name":"use_did","description":"Filter by Use Did","required":false,"schema":{"type":"string","enum":["Disabled","Filter","Random","Prefix Match","Performance"]}},{"in":"query","name":"stir_shaken_attestation","description":"Filter by Stir Shaken Attestation","required":false,"schema":{"type":"string","enum":["None","A","B","C"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/cli"}},"example":[{"id":12345,"company_id":1,"cli":"example_cli","cli_rewrite":"example_cli_rewrite","p_asserted_identity_rewrite":"example_p_asserted_identity_rewrite","forced":1,"p_asserted_identity":"example_p_asserted_identity","notes":"example_notes","origination":1,"use_did":"Disabled","stir_shaken_cert_id":1,"stir_shaken_attestation":"None","dn_match":"example_dn_match","datastore_id":1,"allow_type":"example_allow_type","ftc_reported":1,"flags":"example_flags","performance_top_batch_size":100,"performance_interval":1000,"performance_ban_time":1000,"hit_limit":123,"hit_interval":1000,"idx":1},{"id":12345,"company_id":1,"cli":"example_cli","cli_rewrite":"example_cli_rewrite","p_asserted_identity_rewrite":"example_p_asserted_identity_rewrite","forced":1,"p_asserted_identity":"example_p_asserted_identity","notes":"example_notes","origination":1,"use_did":"Disabled","stir_shaken_cert_id":1,"stir_shaken_attestation":"None","dn_match":"example_dn_match","datastore_id":1,"allow_type":"example_allow_type","ftc_reported":1,"flags":"example_flags","performance_top_batch_size":100,"performance_interval":1000,"performance_ban_time":1000,"hit_limit":123,"hit_interval":1000,"idx":1}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Cli"],"summary":"Create","description":"Create a new Cli record.","operationId":"cliCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cliInput"},"example":{"company_id":1,"cli":"example_cli","cli_rewrite":"example_cli_rewrite","p_asserted_identity_rewrite":"example_p_asserted_identity_rewrite","forced":1,"p_asserted_identity":"example_p_asserted_identity","notes":"example_notes","origination":1,"use_did":"Disabled","stir_shaken_cert_id":1,"stir_shaken_attestation":"None","dn_match":"example_dn_match","datastore_id":1,"allow_type":"example_allow_type","ftc_reported":1,"flags":"example_flags","performance_top_batch_size":100,"performance_interval":1000,"performance_ban_time":1000,"hit_limit":123,"hit_interval":1000,"idx":1}}}}}},"/api/cp/cli-global":{"get":{"tags":["Cli Global"],"summary":"List","description":"Retrieve a paginated list of Cli Global records. Supports filtering, sorting, and search.","operationId":"cliGlobalList","parameters":[{"in":"query","name":"use_did","description":"Filter by Use Did","required":false,"schema":{"type":"string","enum":["Disabled","Filter","Random","Prefix Match","Performance"]}},{"in":"query","name":"stir_shaken_attestation","description":"Filter by Stir Shaken Attestation","required":false,"schema":{"type":"string","enum":["None","A","B","C"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/cliGlobal"}},"example":[{"id":12345,"account_id":1,"cli":"example_cli","cli_rewrite":"example_cli_rewrite","p_asserted_identity_rewrite":"example_p_asserted_identity_rewrite","forced":1,"p_asserted_identity":"example_p_asserted_identity","notes":"example_notes","origination":1,"use_did":"Disabled","stir_shaken_cert_id":1,"stir_shaken_attestation":"None","dn_match":"example_dn_match","datastore_id":1,"allow_type":"example_allow_type","ftc_reported":1,"tag":"example_tag","flags":"example_flags","performance_top_batch_size":100,"performance_interval":1000,"performance_ban_time":1000,"hit_limit":123,"hit_interval":1000},{"id":12345,"account_id":1,"cli":"example_cli","cli_rewrite":"example_cli_rewrite","p_asserted_identity_rewrite":"example_p_asserted_identity_rewrite","forced":1,"p_asserted_identity":"example_p_asserted_identity","notes":"example_notes","origination":1,"use_did":"Disabled","stir_shaken_cert_id":1,"stir_shaken_attestation":"None","dn_match":"example_dn_match","datastore_id":1,"allow_type":"example_allow_type","ftc_reported":1,"tag":"example_tag","flags":"example_flags","performance_top_batch_size":100,"performance_interval":1000,"performance_ban_time":1000,"hit_limit":123,"hit_interval":1000}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Cli Global"],"summary":"Create","description":"Create a new Cli Global record.","operationId":"cliGlobalCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cliGlobalInput"},"example":{"account_id":1,"cli":"example_cli","cli_rewrite":"example_cli_rewrite","p_asserted_identity_rewrite":"example_p_asserted_identity_rewrite","forced":1,"p_asserted_identity":"example_p_asserted_identity","notes":"example_notes","origination":1,"use_did":"Disabled","stir_shaken_cert_id":1,"stir_shaken_attestation":"None","dn_match":"example_dn_match","datastore_id":1,"allow_type":"example_allow_type","ftc_reported":1,"tag":"example_tag","flags":"example_flags","performance_top_batch_size":100,"performance_interval":1000,"performance_ban_time":1000,"hit_limit":123,"hit_interval":1000}}}}}},"/api/cp/cli-global/{id}":{"get":{"tags":["Cli Global"],"summary":"Read","description":"Retrieve a single Cli Global record by ID.","operationId":"cliGlobalRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cliGlobal"},"example":{"id":12345,"account_id":1,"cli":"example_cli","cli_rewrite":"example_cli_rewrite","p_asserted_identity_rewrite":"example_p_asserted_identity_rewrite","forced":1,"p_asserted_identity":"example_p_asserted_identity","notes":"example_notes","origination":1,"use_did":"Disabled","stir_shaken_cert_id":1,"stir_shaken_attestation":"None","dn_match":"example_dn_match","datastore_id":1,"allow_type":"example_allow_type","ftc_reported":1,"tag":"example_tag","flags":"example_flags","performance_top_batch_size":100,"performance_interval":1000,"performance_ban_time":1000,"hit_limit":123,"hit_interval":1000}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Cli Global"],"summary":"Update","description":"Update an existing Cli Global record by ID.","operationId":"cliGlobalUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cliGlobalInput"},"example":{"account_id":1,"cli":"example_cli","cli_rewrite":"example_cli_rewrite","p_asserted_identity_rewrite":"example_p_asserted_identity_rewrite","forced":1,"p_asserted_identity":"example_p_asserted_identity","notes":"example_notes","origination":1,"use_did":"Disabled","stir_shaken_cert_id":1,"stir_shaken_attestation":"None","dn_match":"example_dn_match","datastore_id":1,"allow_type":"example_allow_type","ftc_reported":1,"tag":"example_tag","flags":"example_flags","performance_top_batch_size":100,"performance_interval":1000,"performance_ban_time":1000,"hit_limit":123,"hit_interval":1000}}}}},"delete":{"tags":["Cli Global"],"summary":"Delete","description":"Delete a Cli Global record by ID.","operationId":"cliGlobalDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/cli/stats/{companyId}":{"get":{"tags":["Cli"],"summary":"CLI Stats","description":"CLI Stats","operationId":"cliCliStats","parameters":[{"in":"path","name":"companyId","description":"Company Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cli"},"example":{"id":12345,"company_id":1,"cli":"example_cli","cli_rewrite":"example_cli_rewrite","p_asserted_identity_rewrite":"example_p_asserted_identity_rewrite","forced":1,"p_asserted_identity":"example_p_asserted_identity","notes":"example_notes","origination":1,"use_did":"Disabled","stir_shaken_cert_id":1,"stir_shaken_attestation":"None","dn_match":"example_dn_match","datastore_id":1,"allow_type":"example_allow_type","ftc_reported":1,"flags":"example_flags","performance_top_batch_size":100,"performance_interval":1000,"performance_ban_time":1000,"hit_limit":123,"hit_interval":1000,"idx":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/cli/{id}":{"get":{"tags":["Cli"],"summary":"Read","description":"Retrieve a single Cli record by ID.","operationId":"cliRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cli"},"example":{"id":12345,"company_id":1,"cli":"example_cli","cli_rewrite":"example_cli_rewrite","p_asserted_identity_rewrite":"example_p_asserted_identity_rewrite","forced":1,"p_asserted_identity":"example_p_asserted_identity","notes":"example_notes","origination":1,"use_did":"Disabled","stir_shaken_cert_id":1,"stir_shaken_attestation":"None","dn_match":"example_dn_match","datastore_id":1,"allow_type":"example_allow_type","ftc_reported":1,"flags":"example_flags","performance_top_batch_size":100,"performance_interval":1000,"performance_ban_time":1000,"hit_limit":123,"hit_interval":1000,"idx":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Cli"],"summary":"Update","description":"Update an existing Cli record by ID.","operationId":"cliUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cliInput"},"example":{"company_id":1,"cli":"example_cli","cli_rewrite":"example_cli_rewrite","p_asserted_identity_rewrite":"example_p_asserted_identity_rewrite","forced":1,"p_asserted_identity":"example_p_asserted_identity","notes":"example_notes","origination":1,"use_did":"Disabled","stir_shaken_cert_id":1,"stir_shaken_attestation":"None","dn_match":"example_dn_match","datastore_id":1,"allow_type":"example_allow_type","ftc_reported":1,"flags":"example_flags","performance_top_batch_size":100,"performance_interval":1000,"performance_ban_time":1000,"hit_limit":123,"hit_interval":1000,"idx":1}}}}},"delete":{"tags":["Cli"],"summary":"Delete","description":"Delete a Cli record by ID.","operationId":"cliDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/connexamine":{"get":{"tags":["Connexamine"],"summary":"List","description":"Retrieve a paginated list of Connexamine records. Supports filtering, sorting, and search.","operationId":"connexamineList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Connexamine"],"summary":"Create","description":"Create a new Connexamine record.","operationId":"connexamineCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/connexamine/ws/{session_id}":{"socket":{"tags":["Connexamine"],"summary":"Connexamine WebSocket","description":"Connexamine WebSocket","operationId":"connexamineConnexamineWebSocket","parameters":[{"in":"path","name":"session_id","description":"Session Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/connexamine/{id}":{"get":{"tags":["Connexamine"],"summary":"Read","description":"Retrieve a single Connexamine record by ID.","operationId":"connexamineRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"delete":{"tags":["Connexamine"],"summary":"Delete","description":"Delete a Connexamine record by ID.","operationId":"connexamineDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/contact":{"get":{"tags":["Contact"],"summary":"List","description":"Retrieve a paginated list of Contact records. Supports filtering, sorting, and search.","operationId":"contactList","parameters":[{"in":"query","name":"contact_type","description":"Filter by Contact Type","required":false,"schema":{"type":"string","enum":["General","Sales","Accounts","NOC","Rates"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/contact"}},"example":[{"id":12345,"company_id":1,"name":"Example Name","email":"user@example.com","contact_type":"General","phone":"+1-555-123-4567","mobile":"+1-555-123-4567","skype":"example_skype","public_notes":"Sample public_notes text content","private_notes":"Sample private_notes text content","logins":123,"last_login":"2025-01-17T10:30:00Z","portal_area":"example_portal_area","mobile_verify":1,"email_verify":1,"ip_whitelist":"example_ip_whitelist"},{"id":12345,"company_id":1,"name":"Example Name","email":"user@example.com","contact_type":"General","phone":"+1-555-123-4567","mobile":"+1-555-123-4567","skype":"example_skype","public_notes":"Sample public_notes text content","private_notes":"Sample private_notes text content","logins":123,"last_login":"2025-01-17T10:30:00Z","portal_area":"example_portal_area","mobile_verify":1,"email_verify":1,"ip_whitelist":"example_ip_whitelist"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Contact"],"summary":"Create","description":"Create a new Contact record.","operationId":"contactCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/contactInput"},"example":{"company_id":1,"name":"Example Name","email":"user@example.com","contact_type":"General","phone":"+1-555-123-4567","mobile":"+1-555-123-4567","skype":"example_skype","public_notes":"Sample public_notes text content","private_notes":"Sample private_notes text content","logins":123,"last_login":"2025-01-17T10:30:00Z","portal_area":"example_portal_area","mobile_verify":1,"email_verify":1,"ip_whitelist":"example_ip_whitelist"}}}}}},"/api/cp/contact/login/{id}":{"get":{"tags":["Contact"],"summary":"Login","description":"Login","operationId":"contactLogin","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contact"},"example":{"id":12345,"company_id":1,"name":"Example Name","email":"user@example.com","contact_type":"General","phone":"+1-555-123-4567","mobile":"+1-555-123-4567","skype":"example_skype","public_notes":"Sample public_notes text content","private_notes":"Sample private_notes text content","logins":123,"last_login":"2025-01-17T10:30:00Z","portal_area":"example_portal_area","mobile_verify":1,"email_verify":1,"ip_whitelist":"example_ip_whitelist"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/contact/{id}":{"get":{"tags":["Contact"],"summary":"Read","description":"Retrieve a single Contact record by ID.","operationId":"contactRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contact"},"example":{"id":12345,"company_id":1,"name":"Example Name","email":"user@example.com","contact_type":"General","phone":"+1-555-123-4567","mobile":"+1-555-123-4567","skype":"example_skype","public_notes":"Sample public_notes text content","private_notes":"Sample private_notes text content","logins":123,"last_login":"2025-01-17T10:30:00Z","portal_area":"example_portal_area","mobile_verify":1,"email_verify":1,"ip_whitelist":"example_ip_whitelist"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Contact"],"summary":"Update","description":"Update an existing Contact record by ID.","operationId":"contactUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/contactInput"},"example":{"company_id":1,"name":"Example Name","email":"user@example.com","contact_type":"General","phone":"+1-555-123-4567","mobile":"+1-555-123-4567","skype":"example_skype","public_notes":"Sample public_notes text content","private_notes":"Sample private_notes text content","logins":123,"last_login":"2025-01-17T10:30:00Z","portal_area":"example_portal_area","mobile_verify":1,"email_verify":1,"ip_whitelist":"example_ip_whitelist"}}}}},"delete":{"tags":["Contact"],"summary":"Delete","description":"Delete a Contact record by ID.","operationId":"contactDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/contract":{"get":{"tags":["Contract"],"summary":"List","description":"Retrieve a paginated list of Contract records. Supports filtering, sorting, and search.","operationId":"contractList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/contract"}},"example":[{"id":12345,"contract_rev_id":1,"company_id":1,"route_ingress_id":1,"required":1,"date_created":"2025-01-17T10:30:00Z","date_grace":"2025-01-17T10:30:00Z","date_approved":"2025-01-17T10:30:00Z","approved_by":"example_approved_by","identity_id":1},{"id":12345,"contract_rev_id":1,"company_id":1,"route_ingress_id":1,"required":1,"date_created":"2025-01-17T10:30:00Z","date_grace":"2025-01-17T10:30:00Z","date_approved":"2025-01-17T10:30:00Z","approved_by":"example_approved_by","identity_id":1}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Contract"],"summary":"Create","description":"Create a new Contract record.","operationId":"contractCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/contractInput"},"example":{"contract_rev_id":1,"company_id":1,"route_ingress_id":1,"required":1,"date_created":"2025-01-17T10:30:00Z","date_grace":"2025-01-17T10:30:00Z","date_approved":"2025-01-17T10:30:00Z","approved_by":"example_approved_by","identity_id":1}}}}}},"/api/cp/contract/{id}":{"get":{"tags":["Contract"],"summary":"Read","description":"Retrieve a single Contract record by ID.","operationId":"contractRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contract"},"example":{"id":12345,"contract_rev_id":1,"company_id":1,"route_ingress_id":1,"required":1,"date_created":"2025-01-17T10:30:00Z","date_grace":"2025-01-17T10:30:00Z","date_approved":"2025-01-17T10:30:00Z","approved_by":"example_approved_by","identity_id":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"delete":{"tags":["Contract"],"summary":"Delete","description":"Delete a Contract record by ID.","operationId":"contractDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/customer":{"get":{"tags":["Customer"],"summary":"List","description":"Retrieve a paginated list of Customer records. Supports filtering, sorting, and search.","operationId":"customerList","parameters":[{"in":"query","name":"status","description":"Filter by Status","required":false,"schema":{"type":"string"}},{"in":"query","name":"p_asserted_identity","description":"Filter by P Asserted Identity","required":false,"schema":{"type":"string","enum":["default","remove","if-available","required"]}},{"in":"query","name":"invoice_schedule","description":"Filter by Invoice Schedule","required":false,"schema":{"type":"string","enum":["day","week","bimonth","month","disabled"]}},{"in":"query","name":"default_stir_shaken_attestation","description":"Filter by Default Stir Shaken Attestation","required":false,"schema":{"type":"string","enum":["A","B","C"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/customer"}},"example":[{"id":12345,"account_id":1,"reseller_id":1,"name":"Example Name","alias":"example_alias","channels":123,"cps":1.5,"system_id":1,"status":"Active","address1":"example_address1","address2":"example_address2","city":"example_city","county":10,"postcode":"example_postcode","website":"https://example.com","country":"US","credit_refresh_interval":123,"portal_json":"Sample portal_json text content","portal_url":"example_portal_url","portal_username":"example_portal_username","portal_password":"example_portal_password","email_credit_regex":"example_email_credit_regex","trace":1,"credit":99.99,"debit_limit":99.99,"tax":99.99,"snapshot_credit":99.99,"snapshot_timestamp":1000000,"currency":"USD","paypal":"example_paypal","portal_access":"example_portal_access","is_customer":true,"is_carrier":true,"last_call":1000000,"auto_login_key":"example_auto_login_key","connexcs_permission":"example_connexcs_permission","fr_timeout":1,"pre_ring_timeout":1,"post_ring_timeout":1,"p_asserted_identity":"default","reply_actions":"example_reply_actions","reply_actions_json":"example_reply_actions_json","did_api_id":1,"account_api_id":1,"resources_used":"base64-encoded-data","code_consistency":99.99,"code_consistency_points":99.99,"min_payment":99.99,"approved_cli_only":1,"invoice_schedule":"day","invoice_due_days":1,"propagate_username":1,"required":"mobile_verification","duration_latency_offset":99.99,"notes":"Sample notes text content","consec_backoff":1,"tags":"example_tags","vars":"Sample vars text content","topup_currencies":"example_topup_currencies","accounting_id":1,"invoice_template":"example_invoice_template","account_manager_id":1,"origid":"example_origid","rtp_firewall_warning":1,"s3_size":1.5,"call_recording_retention_days":123,"range_holder_provider_card_id":1,"domain_id":1,"cx_referal":1,"max_daily_spend":99.99,"dt_restrict":"example_dt_restrict","default_stir_shaken_attestation":"A","flags":"example_flags"},{"id":12345,"account_id":1,"reseller_id":1,"name":"Example Name","alias":"example_alias","channels":123,"cps":1.5,"system_id":1,"status":"Active","address1":"example_address1","address2":"example_address2","city":"example_city","county":10,"postcode":"example_postcode","website":"https://example.com","country":"US","credit_refresh_interval":123,"portal_json":"Sample portal_json text content","portal_url":"example_portal_url","portal_username":"example_portal_username","portal_password":"example_portal_password","email_credit_regex":"example_email_credit_regex","trace":1,"credit":99.99,"debit_limit":99.99,"tax":99.99,"snapshot_credit":99.99,"snapshot_timestamp":1000000,"currency":"USD","paypal":"example_paypal","portal_access":"example_portal_access","is_customer":true,"is_carrier":true,"last_call":1000000,"auto_login_key":"example_auto_login_key","connexcs_permission":"example_connexcs_permission","fr_timeout":1,"pre_ring_timeout":1,"post_ring_timeout":1,"p_asserted_identity":"default","reply_actions":"example_reply_actions","reply_actions_json":"example_reply_actions_json","did_api_id":1,"account_api_id":1,"resources_used":"base64-encoded-data","code_consistency":99.99,"code_consistency_points":99.99,"min_payment":99.99,"approved_cli_only":1,"invoice_schedule":"day","invoice_due_days":1,"propagate_username":1,"required":"mobile_verification","duration_latency_offset":99.99,"notes":"Sample notes text content","consec_backoff":1,"tags":"example_tags","vars":"Sample vars text content","topup_currencies":"example_topup_currencies","accounting_id":1,"invoice_template":"example_invoice_template","account_manager_id":1,"origid":"example_origid","rtp_firewall_warning":1,"s3_size":1.5,"call_recording_retention_days":123,"range_holder_provider_card_id":1,"domain_id":1,"cx_referal":1,"max_daily_spend":99.99,"dt_restrict":"example_dt_restrict","default_stir_shaken_attestation":"A","flags":"example_flags"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Customer"],"summary":"Create","description":"Create a new Customer record.","operationId":"customerCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customerInput"},"example":{"account_id":1,"reseller_id":1,"name":"Example Name","alias":"example_alias","channels":123,"cps":1.5,"system_id":1,"status":"Active","address1":"example_address1","address2":"example_address2","city":"example_city","county":10,"postcode":"example_postcode","website":"https://example.com","country":"US","credit_refresh_interval":123,"portal_json":"Sample portal_json text content","portal_url":"example_portal_url","portal_username":"example_portal_username","portal_password":"example_portal_password","email_credit_regex":"example_email_credit_regex","trace":1,"credit":99.99,"debit_limit":99.99,"tax":99.99,"snapshot_credit":99.99,"snapshot_timestamp":1000000,"currency":"USD","paypal":"example_paypal","portal_access":"example_portal_access","is_customer":true,"is_carrier":true,"last_call":1000000,"auto_login_key":"example_auto_login_key","connexcs_permission":"example_connexcs_permission","fr_timeout":1,"pre_ring_timeout":1,"post_ring_timeout":1,"p_asserted_identity":"default","reply_actions":"example_reply_actions","reply_actions_json":"example_reply_actions_json","did_api_id":1,"account_api_id":1,"resources_used":"base64-encoded-data","code_consistency":99.99,"code_consistency_points":99.99,"min_payment":99.99,"approved_cli_only":1,"invoice_schedule":"day","invoice_due_days":1,"propagate_username":1,"required":"mobile_verification","duration_latency_offset":99.99,"notes":"Sample notes text content","consec_backoff":1,"tags":"example_tags","vars":"Sample vars text content","topup_currencies":"example_topup_currencies","accounting_id":1,"invoice_template":"example_invoice_template","account_manager_id":1,"origid":"example_origid","rtp_firewall_warning":1,"s3_size":1.5,"call_recording_retention_days":123,"range_holder_provider_card_id":1,"domain_id":1,"cx_referal":1,"max_daily_spend":99.99,"dt_restrict":"example_dt_restrict","default_stir_shaken_attestation":"A","flags":"example_flags"}}}}}},"/api/cp/customer/email":{"post":{"tags":["Customer"],"summary":"Email","description":"Email","operationId":"customerEmail","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customerInput"},"example":{"account_id":1,"reseller_id":1,"name":"Example Name","alias":"example_alias","channels":123,"cps":1.5,"system_id":1,"status":"Active","address1":"example_address1","address2":"example_address2","city":"example_city","county":10,"postcode":"example_postcode","website":"https://example.com","country":"US","credit_refresh_interval":123,"portal_json":"Sample portal_json text content","portal_url":"example_portal_url","portal_username":"example_portal_username","portal_password":"example_portal_password","email_credit_regex":"example_email_credit_regex","trace":1,"credit":99.99,"debit_limit":99.99,"tax":99.99,"snapshot_credit":99.99,"snapshot_timestamp":1000000,"currency":"USD","paypal":"example_paypal","portal_access":"example_portal_access","is_customer":true,"is_carrier":true,"last_call":1000000,"auto_login_key":"example_auto_login_key","connexcs_permission":"example_connexcs_permission","fr_timeout":1,"pre_ring_timeout":1,"post_ring_timeout":1,"p_asserted_identity":"default","reply_actions":"example_reply_actions","reply_actions_json":"example_reply_actions_json","did_api_id":1,"account_api_id":1,"resources_used":"base64-encoded-data","code_consistency":99.99,"code_consistency_points":99.99,"min_payment":99.99,"approved_cli_only":1,"invoice_schedule":"day","invoice_due_days":1,"propagate_username":1,"required":"mobile_verification","duration_latency_offset":99.99,"notes":"Sample notes text content","consec_backoff":1,"tags":"example_tags","vars":"Sample vars text content","topup_currencies":"example_topup_currencies","accounting_id":1,"invoice_template":"example_invoice_template","account_manager_id":1,"origid":"example_origid","rtp_firewall_warning":1,"s3_size":1.5,"call_recording_retention_days":123,"range_holder_provider_card_id":1,"domain_id":1,"cx_referal":1,"max_daily_spend":99.99,"dt_restrict":"example_dt_restrict","default_stir_shaken_attestation":"A","flags":"example_flags"}}}}}},"/api/cp/customer/referral":{"post":{"tags":["Customer"],"summary":"Referral","description":"Referral","operationId":"customerReferral","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customerInput"},"example":{"account_id":1,"reseller_id":1,"name":"Example Name","alias":"example_alias","channels":123,"cps":1.5,"system_id":1,"status":"Active","address1":"example_address1","address2":"example_address2","city":"example_city","county":10,"postcode":"example_postcode","website":"https://example.com","country":"US","credit_refresh_interval":123,"portal_json":"Sample portal_json text content","portal_url":"example_portal_url","portal_username":"example_portal_username","portal_password":"example_portal_password","email_credit_regex":"example_email_credit_regex","trace":1,"credit":99.99,"debit_limit":99.99,"tax":99.99,"snapshot_credit":99.99,"snapshot_timestamp":1000000,"currency":"USD","paypal":"example_paypal","portal_access":"example_portal_access","is_customer":true,"is_carrier":true,"last_call":1000000,"auto_login_key":"example_auto_login_key","connexcs_permission":"example_connexcs_permission","fr_timeout":1,"pre_ring_timeout":1,"post_ring_timeout":1,"p_asserted_identity":"default","reply_actions":"example_reply_actions","reply_actions_json":"example_reply_actions_json","did_api_id":1,"account_api_id":1,"resources_used":"base64-encoded-data","code_consistency":99.99,"code_consistency_points":99.99,"min_payment":99.99,"approved_cli_only":1,"invoice_schedule":"day","invoice_due_days":1,"propagate_username":1,"required":"mobile_verification","duration_latency_offset":99.99,"notes":"Sample notes text content","consec_backoff":1,"tags":"example_tags","vars":"Sample vars text content","topup_currencies":"example_topup_currencies","accounting_id":1,"invoice_template":"example_invoice_template","account_manager_id":1,"origid":"example_origid","rtp_firewall_warning":1,"s3_size":1.5,"call_recording_retention_days":123,"range_holder_provider_card_id":1,"domain_id":1,"cx_referal":1,"max_daily_spend":99.99,"dt_restrict":"example_dt_restrict","default_stir_shaken_attestation":"A","flags":"example_flags"}}}}}},"/api/cp/customer/sms":{"post":{"tags":["Customer"],"summary":"SMS","description":"SMS","operationId":"customerSms","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customerInput"},"example":{"account_id":1,"reseller_id":1,"name":"Example Name","alias":"example_alias","channels":123,"cps":1.5,"system_id":1,"status":"Active","address1":"example_address1","address2":"example_address2","city":"example_city","county":10,"postcode":"example_postcode","website":"https://example.com","country":"US","credit_refresh_interval":123,"portal_json":"Sample portal_json text content","portal_url":"example_portal_url","portal_username":"example_portal_username","portal_password":"example_portal_password","email_credit_regex":"example_email_credit_regex","trace":1,"credit":99.99,"debit_limit":99.99,"tax":99.99,"snapshot_credit":99.99,"snapshot_timestamp":1000000,"currency":"USD","paypal":"example_paypal","portal_access":"example_portal_access","is_customer":true,"is_carrier":true,"last_call":1000000,"auto_login_key":"example_auto_login_key","connexcs_permission":"example_connexcs_permission","fr_timeout":1,"pre_ring_timeout":1,"post_ring_timeout":1,"p_asserted_identity":"default","reply_actions":"example_reply_actions","reply_actions_json":"example_reply_actions_json","did_api_id":1,"account_api_id":1,"resources_used":"base64-encoded-data","code_consistency":99.99,"code_consistency_points":99.99,"min_payment":99.99,"approved_cli_only":1,"invoice_schedule":"day","invoice_due_days":1,"propagate_username":1,"required":"mobile_verification","duration_latency_offset":99.99,"notes":"Sample notes text content","consec_backoff":1,"tags":"example_tags","vars":"Sample vars text content","topup_currencies":"example_topup_currencies","accounting_id":1,"invoice_template":"example_invoice_template","account_manager_id":1,"origid":"example_origid","rtp_firewall_warning":1,"s3_size":1.5,"call_recording_retention_days":123,"range_holder_provider_card_id":1,"domain_id":1,"cx_referal":1,"max_daily_spend":99.99,"dt_restrict":"example_dt_restrict","default_stir_shaken_attestation":"A","flags":"example_flags"}}}}}},"/api/cp/customer/{id}":{"get":{"tags":["Customer"],"summary":"Read","description":"Retrieve a single Customer record by ID.","operationId":"customerRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer"},"example":{"id":12345,"account_id":1,"reseller_id":1,"name":"Example Name","alias":"example_alias","channels":123,"cps":1.5,"system_id":1,"status":"Active","address1":"example_address1","address2":"example_address2","city":"example_city","county":10,"postcode":"example_postcode","website":"https://example.com","country":"US","credit_refresh_interval":123,"portal_json":"Sample portal_json text content","portal_url":"example_portal_url","portal_username":"example_portal_username","portal_password":"example_portal_password","email_credit_regex":"example_email_credit_regex","trace":1,"credit":99.99,"debit_limit":99.99,"tax":99.99,"snapshot_credit":99.99,"snapshot_timestamp":1000000,"currency":"USD","paypal":"example_paypal","portal_access":"example_portal_access","is_customer":true,"is_carrier":true,"last_call":1000000,"auto_login_key":"example_auto_login_key","connexcs_permission":"example_connexcs_permission","fr_timeout":1,"pre_ring_timeout":1,"post_ring_timeout":1,"p_asserted_identity":"default","reply_actions":"example_reply_actions","reply_actions_json":"example_reply_actions_json","did_api_id":1,"account_api_id":1,"resources_used":"base64-encoded-data","code_consistency":99.99,"code_consistency_points":99.99,"min_payment":99.99,"approved_cli_only":1,"invoice_schedule":"day","invoice_due_days":1,"propagate_username":1,"required":"mobile_verification","duration_latency_offset":99.99,"notes":"Sample notes text content","consec_backoff":1,"tags":"example_tags","vars":"Sample vars text content","topup_currencies":"example_topup_currencies","accounting_id":1,"invoice_template":"example_invoice_template","account_manager_id":1,"origid":"example_origid","rtp_firewall_warning":1,"s3_size":1.5,"call_recording_retention_days":123,"range_holder_provider_card_id":1,"domain_id":1,"cx_referal":1,"max_daily_spend":99.99,"dt_restrict":"example_dt_restrict","default_stir_shaken_attestation":"A","flags":"example_flags"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Customer"],"summary":"Update","description":"Update an existing Customer record by ID.","operationId":"customerUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customerInput"},"example":{"account_id":1,"reseller_id":1,"name":"Example Name","alias":"example_alias","channels":123,"cps":1.5,"system_id":1,"status":"Active","address1":"example_address1","address2":"example_address2","city":"example_city","county":10,"postcode":"example_postcode","website":"https://example.com","country":"US","credit_refresh_interval":123,"portal_json":"Sample portal_json text content","portal_url":"example_portal_url","portal_username":"example_portal_username","portal_password":"example_portal_password","email_credit_regex":"example_email_credit_regex","trace":1,"credit":99.99,"debit_limit":99.99,"tax":99.99,"snapshot_credit":99.99,"snapshot_timestamp":1000000,"currency":"USD","paypal":"example_paypal","portal_access":"example_portal_access","is_customer":true,"is_carrier":true,"last_call":1000000,"auto_login_key":"example_auto_login_key","connexcs_permission":"example_connexcs_permission","fr_timeout":1,"pre_ring_timeout":1,"post_ring_timeout":1,"p_asserted_identity":"default","reply_actions":"example_reply_actions","reply_actions_json":"example_reply_actions_json","did_api_id":1,"account_api_id":1,"resources_used":"base64-encoded-data","code_consistency":99.99,"code_consistency_points":99.99,"min_payment":99.99,"approved_cli_only":1,"invoice_schedule":"day","invoice_due_days":1,"propagate_username":1,"required":"mobile_verification","duration_latency_offset":99.99,"notes":"Sample notes text content","consec_backoff":1,"tags":"example_tags","vars":"Sample vars text content","topup_currencies":"example_topup_currencies","accounting_id":1,"invoice_template":"example_invoice_template","account_manager_id":1,"origid":"example_origid","rtp_firewall_warning":1,"s3_size":1.5,"call_recording_retention_days":123,"range_holder_provider_card_id":1,"domain_id":1,"cx_referal":1,"max_daily_spend":99.99,"dt_restrict":"example_dt_restrict","default_stir_shaken_attestation":"A","flags":"example_flags"}}}}},"delete":{"tags":["Customer"],"summary":"Delete","description":"Delete a Customer record by ID.","operationId":"customerDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/cx-cli":{"socket":{"tags":["CX CLI Proxy"],"summary":"CX CLI WebSocket Proxy","description":"CX CLI WebSocket Proxy","operationId":"cxCliProxyCxCliWebSocketProxy","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/cx-package":{"get":{"tags":["Cx Package"],"summary":"List","description":"Retrieve a paginated list of Cx Package records. Supports filtering, sorting, and search.","operationId":"cxPackageList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/cxPackage"}},"example":[{"id":12345,"key":"example_key","name":"Example Name","cost":99.99,"qty_units":"example_qty_units","flag":"MRC","description":"A detailed description of the resource","icon":"example_icon"},{"id":12345,"key":"example_key","name":"Example Name","cost":99.99,"qty_units":"example_qty_units","flag":"MRC","description":"A detailed description of the resource","icon":"example_icon"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false}},"/api/cp/cx-voucher":{"get":{"tags":["Setup Voucher"],"summary":"List","description":"Retrieve a paginated list of Setup Voucher records. Supports filtering, sorting, and search.","operationId":"setupVoucherList","parameters":[{"in":"query","name":"state","description":"Filter by State","required":false,"schema":{"type":"string","enum":["Active","Inactive","Used"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupVoucher"}},"example":[{"id":12345,"code":"example_code","end_date":"2025-01-17T10:30:00Z","state":"Active","description":"A detailed description of the resource","min_activation":99.99,"multiplier":99.99,"addition":99.99,"used_by_account_id":1,"use_once":1},{"id":12345,"code":"example_code","end_date":"2025-01-17T10:30:00Z","state":"Active","description":"A detailed description of the resource","min_activation":99.99,"multiplier":99.99,"addition":99.99,"used_by_account_id":1,"use_once":1}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Voucher"],"summary":"Create","description":"Create a new Setup Voucher record.","operationId":"setupVoucherCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupVoucherInput"},"example":{"code":"example_code","end_date":"2025-01-17T10:30:00Z","state":"Active","description":"A detailed description of the resource","min_activation":99.99,"multiplier":99.99,"addition":99.99,"used_by_account_id":1,"use_once":1}}}}}},"/api/cp/dev/anvil/components":{"get":{"tags":["Anvil Components"],"summary":"List","description":"Retrieve a paginated list of Anvil Components records. Supports filtering, sorting, and search.","operationId":"anvilComponentsList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/file-lookup/{fileId}":{"get":{"tags":["Anvil File Lookup"],"summary":"Lookup Project By File ID","description":"Lookup Project By File ID","operationId":"anvilFileLookupLookupProjectByFileId","parameters":[{"in":"path","name":"fileId","description":"File Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/projects":{"get":{"tags":["Anvil Projects"],"summary":"List","description":"Retrieve a paginated list of Anvil Projects records. Supports filtering, sorting, and search.","operationId":"anvilProjectsList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Anvil Projects"],"summary":"Create","description":"Create a new Anvil Projects record.","operationId":"anvilProjectsCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/projects/{projectId}":{"get":{"tags":["Anvil Projects"],"summary":"Get","description":"Get","operationId":"anvilProjectsGet","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Anvil Projects"],"summary":"Update","description":"Update an existing Anvil Projects record by ID.","operationId":"anvilProjectsUpdate","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"delete":{"tags":["Anvil Projects"],"summary":"Delete","description":"Delete a Anvil Projects record by ID.","operationId":"anvilProjectsDelete","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/projects/{projectId}/branches":{"get":{"tags":["Anvil Branches"],"summary":"List Branches","description":"List Branches","operationId":"anvilBranchesListBranches","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Anvil Branches"],"summary":"Create Branch","description":"Create Branch","operationId":"anvilBranchesCreateBranch","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/projects/{projectId}/branches/{name}/checkout":{"post":{"tags":["Anvil Branches"],"summary":"Checkout Branch","description":"Checkout Branch","operationId":"anvilBranchesCheckoutBranch","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"name","description":"Name identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/projects/{projectId}/branches/{name}/merge":{"post":{"tags":["Anvil Branches"],"summary":"Merge Branch","description":"Merge Branch","operationId":"anvilBranchesMergeBranch","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"name","description":"Name identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/projects/{projectId}/build":{"get":{"tags":["Anvil Publish"],"summary":"Get Build State","description":"Get Build State","operationId":"anvilPublishGetBuildState","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Anvil Publish"],"summary":"Trigger Build","description":"Trigger Build","operationId":"anvilPublishTriggerBuild","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/projects/{projectId}/build/{buildId}/activate":{"post":{"tags":["Anvil Publish"],"summary":"Activate Build","description":"Activate Build","operationId":"anvilPublishActivateBuild","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"buildId","description":"Build Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/projects/{projectId}/changes":{"get":{"tags":["Anvil Publish"],"summary":"Check Unpublished Changes","description":"Check Unpublished Changes","operationId":"anvilPublishCheckUnpublishedChanges","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/projects/{projectId}/commits":{"get":{"tags":["Anvil Branches"],"summary":"List Commits","description":"List Commits","operationId":"anvilBranchesListCommits","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/projects/{projectId}/diff":{"get":{"tags":["Anvil Diff"],"summary":"Project Diff","description":"Project Diff","operationId":"anvilDiffProjectDiff","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/projects/{projectId}/domains":{"get":{"tags":["Anvil Domains"],"summary":"List Domains","description":"List Domains","operationId":"anvilDomainsListDomains","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Anvil Domains"],"summary":"Create Domain","description":"Create Domain","operationId":"anvilDomainsCreateDomain","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/projects/{projectId}/domains/{domainId}":{"get":{"tags":["Anvil Domains"],"summary":"Get Domain","description":"Get Domain","operationId":"anvilDomainsGetDomain","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"domainId","description":"Domain Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Anvil Domains"],"summary":"Update Domain","description":"Update Domain","operationId":"anvilDomainsUpdateDomain","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"domainId","description":"Domain Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"delete":{"tags":["Anvil Domains"],"summary":"Delete Domain","description":"Delete Domain","operationId":"anvilDomainsDeleteDomain","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"domainId","description":"Domain Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/projects/{projectId}/files-history/{path(*)}":{"get":{"tags":["Anvil Files"],"summary":"History","description":"History","operationId":"anvilFilesHistory","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"path(*)","description":"Path identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/projects/{projectId}/files-rollback/{path(*)}":{"post":{"tags":["Anvil Files"],"summary":"Rollback","description":"Rollback","operationId":"anvilFilesRollback","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"path(*)","description":"Path identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/projects/{projectId}/files/diff":{"get":{"tags":["Anvil Diff"],"summary":"File Diff","description":"File Diff","operationId":"anvilDiffFileDiff","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/projects/{projectId}/files/{path(*)}":{"get":{"tags":["Anvil Files"],"summary":"Get","description":"Get","operationId":"anvilFilesGet","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"path(*)","description":"Path identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Anvil Files"],"summary":"Create","description":"Create a new Anvil Files record.","operationId":"anvilFilesCreate","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"path(*)","description":"Path identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Anvil Files"],"summary":"Update","description":"Update an existing Anvil Files record by ID.","operationId":"anvilFilesUpdate","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"path(*)","description":"Path identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"delete":{"tags":["Anvil Files"],"summary":"Delete","description":"Delete a Anvil Files record by ID.","operationId":"anvilFilesDelete","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"path(*)","description":"Path identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/projects/{projectId}/publish":{"get":{"tags":["Anvil Publish"],"summary":"Get Published Version","description":"Get Published Version","operationId":"anvilPublishGetPublishedVersion","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Anvil Publish"],"summary":"Publish Project","description":"Publish Project","operationId":"anvilPublishPublishProject","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/projects/{projectId}/regenerate-key":{"post":{"tags":["Anvil Projects"],"summary":"Regenerate API Key","description":"Regenerate API Key","operationId":"anvilProjectsRegenerateApiKey","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/projects/{projectId}/reset":{"post":{"tags":["Anvil Projects"],"summary":"Reset Project","description":"Reset Project","operationId":"anvilProjectsResetProject","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/projects/{projectId}/scriptforge/publish":{"get":{"tags":["Anvil ScriptForge Publish"],"summary":"List ScriptForge Published Versions","description":"List ScriptForge Published Versions","operationId":"anvilScriptForgePublishListScriptForgePublishedVersions","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Anvil ScriptForge Publish"],"summary":"Publish ScriptForge","description":"Publish ScriptForge","operationId":"anvilScriptForgePublishPublishScriptForge","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/projects/{projectId}/snapshots":{"get":{"tags":["Anvil Snapshots"],"summary":"List","description":"Retrieve a paginated list of Anvil Snapshots records. Supports filtering, sorting, and search.","operationId":"anvilSnapshotsList","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Anvil Snapshots"],"summary":"Create","description":"Create a new Anvil Snapshots record.","operationId":"anvilSnapshotsCreate","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/projects/{projectId}/snapshots/{snapshotId}":{"get":{"tags":["Anvil Snapshots"],"summary":"Get","description":"Get","operationId":"anvilSnapshotsGet","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"snapshotId","description":"Snapshot Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"delete":{"tags":["Anvil Snapshots"],"summary":"Delete","description":"Delete a Anvil Snapshots record by ID.","operationId":"anvilSnapshotsDelete","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"snapshotId","description":"Snapshot Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/projects/{projectId}/snapshots/{snapshotId}/restore":{"post":{"tags":["Anvil Snapshots"],"summary":"Restore","description":"Restore","operationId":"anvilSnapshotsRestore","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"snapshotId","description":"Snapshot Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/registry/packages":{"get":{"tags":["Anvil Registry"],"summary":"List Packages","description":"List Packages","operationId":"anvilRegistryListPackages","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Anvil Registry"],"summary":"Create Package","description":"Create Package","operationId":"anvilRegistryCreatePackage","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/registry/packages/installed":{"get":{"tags":["Anvil Registry"],"summary":"List Installed Packages","description":"List Installed Packages","operationId":"anvilRegistryListInstalledPackages","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/registry/packages/mine":{"get":{"tags":["Anvil Registry"],"summary":"List My Packages","description":"List My Packages","operationId":"anvilRegistryListMyPackages","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/registry/packages/{packageId}":{"get":{"tags":["Anvil Registry"],"summary":"Get Package","description":"Get Package","operationId":"anvilRegistryGetPackage","parameters":[{"in":"path","name":"packageId","description":"Package Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"patch":{"tags":["Anvil Registry"],"summary":"Update Package","description":"Update Package","operationId":"anvilRegistryUpdatePackage","parameters":[{"in":"path","name":"packageId","description":"Package Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"delete":{"tags":["Anvil Registry"],"summary":"Delete Package","description":"Delete Package","operationId":"anvilRegistryDeletePackage","parameters":[{"in":"path","name":"packageId","description":"Package Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/registry/packages/{packageId}/install":{"post":{"tags":["Anvil Registry"],"summary":"Install Package","description":"Install Package","operationId":"anvilRegistryInstallPackage","parameters":[{"in":"path","name":"packageId","description":"Package Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/registry/packages/{packageId}/releases":{"get":{"tags":["Anvil Registry"],"summary":"List Releases","description":"List Releases","operationId":"anvilRegistryListReleases","parameters":[{"in":"path","name":"packageId","description":"Package Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Anvil Registry"],"summary":"Submit Release","description":"Submit Release","operationId":"anvilRegistrySubmitRelease","parameters":[{"in":"path","name":"packageId","description":"Package Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/registry/packages/{packageId}/releases/{version}":{"get":{"tags":["Anvil Registry"],"summary":"Get Release","description":"Get Release","operationId":"anvilRegistryGetRelease","parameters":[{"in":"path","name":"packageId","description":"Package Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"version","description":"Version identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/registry/packages/{packageId}/releases/{version}/withdraw":{"post":{"tags":["Anvil Registry"],"summary":"Withdraw Release","description":"Withdraw Release","operationId":"anvilRegistryWithdrawRelease","parameters":[{"in":"path","name":"packageId","description":"Package Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"version","description":"Version identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/registry/projects/{projectId}/upgrade":{"post":{"tags":["Anvil Registry"],"summary":"Upgrade Project","description":"Upgrade Project","operationId":"anvilRegistryUpgradeProject","parameters":[{"in":"path","name":"projectId","description":"Project Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/anvil/starters":{"get":{"tags":["Anvil Starters"],"summary":"List","description":"Retrieve a paginated list of Anvil Starters records. Supports filtering, sorting, and search.","operationId":"anvilStartersList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/app":{"get":{"tags":["Setup App"],"summary":"List","description":"Retrieve a paginated list of Setup App records. Supports filtering, sorting, and search.","operationId":"setupAppList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupApp"}},"example":[{"id":12345,"account_id":1,"repo_id":1,"name":"Example Name","version":"example_version","domain":"example_domain","company_id":1,"framework_version":"example_framework_version","icon":"example_icon","anvil_mcp_api_key":"example_anvil_mcp_api_key"},{"id":12345,"account_id":1,"repo_id":1,"name":"Example Name","version":"example_version","domain":"example_domain","company_id":1,"framework_version":"example_framework_version","icon":"example_icon","anvil_mcp_api_key":"example_anvil_mcp_api_key"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup App"],"summary":"Create","description":"Create a new Setup App record.","operationId":"setupAppCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupAppInput"},"example":{"account_id":1,"repo_id":1,"name":"Example Name","version":"example_version","domain":"example_domain","company_id":1,"framework_version":"example_framework_version","icon":"example_icon","anvil_mcp_api_key":"example_anvil_mcp_api_key"}}}}}},"/api/cp/dev/app/publish/{id}":{"post":{"tags":["Setup App"],"summary":"Publish","description":"Publish","operationId":"setupAppPublish","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupAppInput"},"example":{"account_id":1,"repo_id":1,"name":"Example Name","version":"example_version","domain":"example_domain","company_id":1,"framework_version":"example_framework_version","icon":"example_icon","anvil_mcp_api_key":"example_anvil_mcp_api_key"}}}}}},"/api/cp/dev/app/tools/{id}":{"get":{"tags":["Setup App"],"summary":"App Tools","description":"App Tools","operationId":"setupAppAppTools","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupApp"},"example":{"id":12345,"account_id":1,"repo_id":1,"name":"Example Name","version":"example_version","domain":"example_domain","company_id":1,"framework_version":"example_framework_version","icon":"example_icon","anvil_mcp_api_key":"example_anvil_mcp_api_key"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/app/upgrade/{id}":{"put":{"tags":["Setup App"],"summary":"Upgrade","description":"Upgrade","operationId":"setupAppUpgrade","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupAppInput"},"example":{"account_id":1,"repo_id":1,"name":"Example Name","version":"example_version","domain":"example_domain","company_id":1,"framework_version":"example_framework_version","icon":"example_icon","anvil_mcp_api_key":"example_anvil_mcp_api_key"}}}}}},"/api/cp/dev/app/{id}":{"get":{"tags":["Setup App"],"summary":"Read","description":"Retrieve a single Setup App record by ID.","operationId":"setupAppRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupApp"},"example":{"id":12345,"account_id":1,"repo_id":1,"name":"Example Name","version":"example_version","domain":"example_domain","company_id":1,"framework_version":"example_framework_version","icon":"example_icon","anvil_mcp_api_key":"example_anvil_mcp_api_key"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup App"],"summary":"Update","description":"Update an existing Setup App record by ID.","operationId":"setupAppUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupAppInput"},"example":{"account_id":1,"repo_id":1,"name":"Example Name","version":"example_version","domain":"example_domain","company_id":1,"framework_version":"example_framework_version","icon":"example_icon","anvil_mcp_api_key":"example_anvil_mcp_api_key"}}}}},"delete":{"tags":["Setup App"],"summary":"Delete","description":"Delete a Setup App record by ID.","operationId":"setupAppDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/button":{"get":{"tags":["Dev Button"],"summary":"List","description":"Retrieve a paginated list of Dev Button records. Supports filtering, sorting, and search.","operationId":"devButtonList","parameters":[{"in":"query","name":"type","description":"Filter by Type","required":false,"schema":{"type":"string"}},{"in":"query","name":"open_mode","description":"Filter by Open Mode","required":false,"schema":{"type":"string","enum":["page","dialog"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/devButton"}},"example":[{"id":12345,"account_id":1,"company_id":1,"app_id":1,"anvil_path":"example_anvil_path","label":"example_label","icon":"example_icon","tooltip":"example_tooltip","type":"example_type","area":"example_area","placement":"example_placement","min_select":123,"max_select":123,"sandbox_id":1,"fn":"example_fn","form_id":1,"page_id":1,"sort_order":1,"company_ids":"example_company_ids","open_mode":"page"},{"id":12345,"account_id":1,"company_id":1,"app_id":1,"anvil_path":"example_anvil_path","label":"example_label","icon":"example_icon","tooltip":"example_tooltip","type":"example_type","area":"example_area","placement":"example_placement","min_select":123,"max_select":123,"sandbox_id":1,"fn":"example_fn","form_id":1,"page_id":1,"sort_order":1,"company_ids":"example_company_ids","open_mode":"page"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Dev Button"],"summary":"Create","description":"Create a new Dev Button record.","operationId":"devButtonCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/devButtonInput"},"example":{"account_id":1,"company_id":1,"app_id":1,"anvil_path":"example_anvil_path","label":"example_label","icon":"example_icon","tooltip":"example_tooltip","type":"example_type","area":"example_area","placement":"example_placement","min_select":123,"max_select":123,"sandbox_id":1,"fn":"example_fn","form_id":1,"page_id":1,"sort_order":1,"company_ids":"example_company_ids","open_mode":"page"}}}}}},"/api/cp/dev/button/{id}":{"get":{"tags":["Dev Button"],"summary":"Read","description":"Retrieve a single Dev Button record by ID.","operationId":"devButtonRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/devButton"},"example":{"id":12345,"account_id":1,"company_id":1,"app_id":1,"anvil_path":"example_anvil_path","label":"example_label","icon":"example_icon","tooltip":"example_tooltip","type":"example_type","area":"example_area","placement":"example_placement","min_select":123,"max_select":123,"sandbox_id":1,"fn":"example_fn","form_id":1,"page_id":1,"sort_order":1,"company_ids":"example_company_ids","open_mode":"page"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Dev Button"],"summary":"Update","description":"Update an existing Dev Button record by ID.","operationId":"devButtonUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/devButtonInput"},"example":{"account_id":1,"company_id":1,"app_id":1,"anvil_path":"example_anvil_path","label":"example_label","icon":"example_icon","tooltip":"example_tooltip","type":"example_type","area":"example_area","placement":"example_placement","min_select":123,"max_select":123,"sandbox_id":1,"fn":"example_fn","form_id":1,"page_id":1,"sort_order":1,"company_ids":"example_company_ids","open_mode":"page"}}}}},"delete":{"tags":["Dev Button"],"summary":"Delete","description":"Delete a Dev Button record by ID.","operationId":"devButtonDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/db":{"get":{"tags":["Dev DB"],"summary":"List","description":"Retrieve a paginated list of Dev DB records. Supports filtering, sorting, and search.","operationId":"devDbList","parameters":[{"in":"query","name":"type","description":"Filter by Type","required":false,"schema":{"type":"string","enum":["mysql"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/devDb"}},"example":[{"id":12345,"app_id":1,"type":"mysql","host":"example_host","port":"example_port","username":"john_doe","password":"********"},{"id":12345,"app_id":1,"type":"mysql","host":"example_host","port":"example_port","username":"john_doe","password":"********"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Dev DB"],"summary":"Create","description":"Create a new Dev DB record.","operationId":"devDbCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/devDbInput"},"example":{"app_id":1,"type":"mysql","host":"example_host","port":"example_port","username":"john_doe","password":"********"}}}}}},"/api/cp/dev/db/insert/{db}/{table}":{"post":{"tags":["Dev DB"],"summary":"Bulk Insert","description":"Bulk Insert","operationId":"devDbBulkInsert","parameters":[{"in":"path","name":"db","description":"Db identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"table","description":"Table identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/devDbInput"},"example":{"app_id":1,"type":"mysql","host":"example_host","port":"example_port","username":"john_doe","password":"********"}}}}}},"/api/cp/dev/db/sql(/{db)}":{"post":{"tags":["Dev DB"],"summary":"SQL","description":"SQL","operationId":"devDbSql","parameters":[{"in":"path","name":"db)","description":"Db identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/devDbInput"},"example":{"app_id":1,"type":"mysql","host":"example_host","port":"example_port","username":"john_doe","password":"********"}}}}}},"/api/cp/dev/db/{id}":{"delete":{"tags":["Dev DB"],"summary":"Delete","description":"Delete a Dev DB record by ID.","operationId":"devDbDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/domain":{"get":{"tags":["Developer - Domain"],"summary":"List","description":"Retrieve a paginated list of Developer - Domain records. Supports filtering, sorting, and search.","operationId":"developerDomainList","parameters":[{"in":"query","name":"platform","description":"Filter by Platform","required":false,"schema":{"type":"string","enum":["page-builder","anvil"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/developerDomain"}},"example":[{"id":12345,"app_id":1,"domain":"example_domain","framework_version":"example_framework_version","flags":"example_flags","sentry_dsn":"example_sentry_dsn","platform":"page-builder"},{"id":12345,"app_id":1,"domain":"example_domain","framework_version":"example_framework_version","flags":"example_flags","sentry_dsn":"example_sentry_dsn","platform":"page-builder"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Developer - Domain"],"summary":"Create","description":"Create a new Developer - Domain record.","operationId":"developerDomainCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/developerDomainInput"},"example":{"app_id":1,"domain":"example_domain","framework_version":"example_framework_version","flags":"example_flags","sentry_dsn":"example_sentry_dsn","platform":"page-builder"}}}}}},"/api/cp/dev/domain/{id}":{"get":{"tags":["Developer - Domain"],"summary":"Read","description":"Retrieve a single Developer - Domain record by ID.","operationId":"developerDomainRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/developerDomain"},"example":{"id":12345,"app_id":1,"domain":"example_domain","framework_version":"example_framework_version","flags":"example_flags","sentry_dsn":"example_sentry_dsn","platform":"page-builder"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Developer - Domain"],"summary":"Update","description":"Update an existing Developer - Domain record by ID.","operationId":"developerDomainUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/developerDomainInput"},"example":{"app_id":1,"domain":"example_domain","framework_version":"example_framework_version","flags":"example_flags","sentry_dsn":"example_sentry_dsn","platform":"page-builder"}}}}},"delete":{"tags":["Developer - Domain"],"summary":"Delete","description":"Delete a Developer - Domain record by ID.","operationId":"developerDomainDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/hearth/jobs/{jobId}":{"get":{"tags":["Hearth Jobs"],"summary":"Get","description":"Get","operationId":"hearthJobsGet","parameters":[{"in":"path","name":"jobId","description":"Job Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/hearth/permissions":{"get":{"tags":["Hearth Permissions"],"summary":"Get","description":"Get","operationId":"hearthPermissionsGet","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/hearth/schemas":{"get":{"tags":["Hearth Schemas"],"summary":"List","description":"Retrieve a paginated list of Hearth Schemas records. Supports filtering, sorting, and search.","operationId":"hearthSchemasList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Hearth Schemas"],"summary":"Create","description":"Create a new Hearth Schemas record.","operationId":"hearthSchemasCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/hearth/schemas/{schema}":{"delete":{"tags":["Hearth Schemas"],"summary":"Delete","description":"Delete a Hearth Schemas record by ID.","operationId":"hearthSchemasDelete","parameters":[{"in":"path","name":"schema","description":"Schema identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/hearth/schemas/{schema}/backup":{"post":{"tags":["Hearth Schemas"],"summary":"Backup","description":"Backup","operationId":"hearthSchemasBackup","parameters":[{"in":"path","name":"schema","description":"Schema identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/hearth/schemas/{schema}/data/{table}":{"get":{"tags":["Hearth Data"],"summary":"List","description":"Retrieve a paginated list of Hearth Data records. Supports filtering, sorting, and search.","operationId":"hearthDataList","parameters":[{"in":"path","name":"schema","description":"Schema identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"table","description":"Table identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Hearth Data"],"summary":"Insert","description":"Insert","operationId":"hearthDataInsert","parameters":[{"in":"path","name":"schema","description":"Schema identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"table","description":"Table identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"patch":{"tags":["Hearth Data"],"summary":"Update","description":"Update an existing Hearth Data record by ID.","operationId":"hearthDataUpdate","parameters":[{"in":"path","name":"schema","description":"Schema identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"table","description":"Table identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"delete":{"tags":["Hearth Data"],"summary":"Delete","description":"Delete a Hearth Data record by ID.","operationId":"hearthDataDelete","parameters":[{"in":"path","name":"schema","description":"Schema identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"table","description":"Table identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/hearth/schemas/{schema}/data/{table}/bulk":{"post":{"tags":["Hearth Data"],"summary":"Bulk Load","description":"Bulk Load","operationId":"hearthDataBulkLoad","parameters":[{"in":"path","name":"schema","description":"Schema identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"table","description":"Table identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/hearth/schemas/{schema}/data/{table}/{id}":{"get":{"tags":["Hearth Data"],"summary":"Get","description":"Get","operationId":"hearthDataGet","parameters":[{"in":"path","name":"schema","description":"Schema identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"table","description":"Table identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Hearth Data"],"summary":"Replace Row","description":"Replace Row","operationId":"hearthDataReplaceRow","parameters":[{"in":"path","name":"schema","description":"Schema identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"table","description":"Table identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"patch":{"tags":["Hearth Data"],"summary":"Update Row","description":"Update Row","operationId":"hearthDataUpdateRow","parameters":[{"in":"path","name":"schema","description":"Schema identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"table","description":"Table identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"delete":{"tags":["Hearth Data"],"summary":"Delete Row","description":"Delete Row","operationId":"hearthDataDeleteRow","parameters":[{"in":"path","name":"schema","description":"Schema identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"table","description":"Table identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/hearth/schemas/{schema}/grants":{"get":{"tags":["Hearth Schemas"],"summary":"List User Grants","description":"List User Grants","operationId":"hearthSchemasListUserGrants","parameters":[{"in":"path","name":"schema","description":"Schema identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/hearth/schemas/{schema}/grants/{userId}":{"put":{"tags":["Hearth Schemas"],"summary":"Set User Grant","description":"Set User Grant","operationId":"hearthSchemasSetUserGrant","parameters":[{"in":"path","name":"schema","description":"Schema identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"userId","description":"User Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/hearth/schemas/{schema}/permissions":{"get":{"tags":["Hearth Schemas"],"summary":"Get Permissions","description":"Get Permissions","operationId":"hearthSchemasGetPermissions","parameters":[{"in":"path","name":"schema","description":"Schema identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/hearth/schemas/{schema}/services":{"get":{"tags":["Hearth Schemas"],"summary":"List Service Grants","description":"List Service Grants","operationId":"hearthSchemasListServiceGrants","parameters":[{"in":"path","name":"schema","description":"Schema identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/hearth/schemas/{schema}/services/{serviceId}":{"put":{"tags":["Hearth Schemas"],"summary":"Set Service Grant","description":"Set Service Grant","operationId":"hearthSchemasSetServiceGrant","parameters":[{"in":"path","name":"schema","description":"Schema identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"serviceId","description":"Service Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/hearth/schemas/{schema}/snapshot":{"get":{"tags":["Hearth Schemas"],"summary":"Snapshot","description":"Snapshot","operationId":"hearthSchemasSnapshot","parameters":[{"in":"path","name":"schema","description":"Schema identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/hearth/schemas/{schema}/tables":{"get":{"tags":["Hearth Tables"],"summary":"List","description":"Retrieve a paginated list of Hearth Tables records. Supports filtering, sorting, and search.","operationId":"hearthTablesList","parameters":[{"in":"path","name":"schema","description":"Schema identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Hearth Tables"],"summary":"Create","description":"Create a new Hearth Tables record.","operationId":"hearthTablesCreate","parameters":[{"in":"path","name":"schema","description":"Schema identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/hearth/schemas/{schema}/tables/{table}":{"get":{"tags":["Hearth Tables"],"summary":"Get","description":"Get","operationId":"hearthTablesGet","parameters":[{"in":"path","name":"schema","description":"Schema identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"table","description":"Table identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"patch":{"tags":["Hearth Tables"],"summary":"Alter","description":"Alter","operationId":"hearthTablesAlter","parameters":[{"in":"path","name":"schema","description":"Schema identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"table","description":"Table identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"delete":{"tags":["Hearth Tables"],"summary":"Delete","description":"Delete a Hearth Tables record by ID.","operationId":"hearthTablesDelete","parameters":[{"in":"path","name":"schema","description":"Schema identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"table","description":"Table identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/hearth/schemas/{schema}/visibility":{"get":{"tags":["Hearth Schemas"],"summary":"Get Visibility","description":"Get Visibility","operationId":"hearthSchemasGetVisibility","parameters":[{"in":"path","name":"schema","description":"Schema identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Hearth Schemas"],"summary":"Set Visibility","description":"Set Visibility","operationId":"hearthSchemasSetVisibility","parameters":[{"in":"path","name":"schema","description":"Schema identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/hearth/whoami":{"get":{"tags":["Hearth Whoami"],"summary":"Get","description":"Get","operationId":"hearthWhoamiGet","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/job":{"get":{"tags":["Jobs (Userspace)"],"summary":"List","description":"Retrieve a paginated list of Jobs (Userspace) records. Supports filtering, sorting, and search.","operationId":"jobsUserspaceList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/jobsUserspace"}},"example":[{"queue":"Sample queue text content","id":12345,"seq":1000000,"name":"Example Name","state":"example_state","data":"example_data","opts":"example_opts","priority":"example_priority","delay_ms":1000000,"max_attempts":"example_max_attempts","attempts_made":"example_attempts_made","attempts_started":"example_attempts_started","progress":"example_progress","return_value":"example_return_value","failed_reason":"Sample failed_reason text content","stacktrace":"example_stacktrace","deferred_failure":"Sample deferred_failure text content","processed_by":"Sample processed_by text content","added_at_ms":1000000,"process_at_ms":1000000,"processed_at_ms":1000000,"finished_at_ms":1000000,"lock_token":"Sample lock_token text content","locked_until_ms":1000000,"stalled_count":10,"dedup_id":1,"scheduler_id":1,"parent_queue":"Sample parent_queue text content","parent_id":1,"parent_key":"Sample parent_key text content","pending_deps":"example_pending_deps","stalled_marked":"example_stalled_marked"},{"queue":"Sample queue text content","id":12345,"seq":1000000,"name":"Example Name","state":"example_state","data":"example_data","opts":"example_opts","priority":"example_priority","delay_ms":1000000,"max_attempts":"example_max_attempts","attempts_made":"example_attempts_made","attempts_started":"example_attempts_started","progress":"example_progress","return_value":"example_return_value","failed_reason":"Sample failed_reason text content","stacktrace":"example_stacktrace","deferred_failure":"Sample deferred_failure text content","processed_by":"Sample processed_by text content","added_at_ms":1000000,"process_at_ms":1000000,"processed_at_ms":1000000,"finished_at_ms":1000000,"lock_token":"Sample lock_token text content","locked_until_ms":1000000,"stalled_count":10,"dedup_id":1,"scheduler_id":1,"parent_queue":"Sample parent_queue text content","parent_id":1,"parent_key":"Sample parent_key text content","pending_deps":"example_pending_deps","stalled_marked":"example_stalled_marked"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/job/queues":{"get":{"tags":["Jobs (Userspace)"],"summary":"Queues List","description":"Queues List","operationId":"jobsUserspaceQueuesList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/jobsUserspace"},"example":{"queue":"Sample queue text content","id":12345,"seq":1000000,"name":"Example Name","state":"example_state","data":"example_data","opts":"example_opts","priority":"example_priority","delay_ms":1000000,"max_attempts":"example_max_attempts","attempts_made":"example_attempts_made","attempts_started":"example_attempts_started","progress":"example_progress","return_value":"example_return_value","failed_reason":"Sample failed_reason text content","stacktrace":"example_stacktrace","deferred_failure":"Sample deferred_failure text content","processed_by":"Sample processed_by text content","added_at_ms":1000000,"process_at_ms":1000000,"processed_at_ms":1000000,"finished_at_ms":1000000,"lock_token":"Sample lock_token text content","locked_until_ms":1000000,"stalled_count":10,"dedup_id":1,"scheduler_id":1,"parent_queue":"Sample parent_queue text content","parent_id":1,"parent_key":"Sample parent_key text content","pending_deps":"example_pending_deps","stalled_marked":"example_stalled_marked"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/job/{queue}/{id}":{"get":{"tags":["Jobs (Userspace)"],"summary":"Read","description":"Retrieve a single Jobs (Userspace) record by ID.","operationId":"jobsUserspaceRead","parameters":[{"in":"path","name":"queue","description":"Queue identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/jobsUserspace"},"example":{"queue":"Sample queue text content","id":12345,"seq":1000000,"name":"Example Name","state":"example_state","data":"example_data","opts":"example_opts","priority":"example_priority","delay_ms":1000000,"max_attempts":"example_max_attempts","attempts_made":"example_attempts_made","attempts_started":"example_attempts_started","progress":"example_progress","return_value":"example_return_value","failed_reason":"Sample failed_reason text content","stacktrace":"example_stacktrace","deferred_failure":"Sample deferred_failure text content","processed_by":"Sample processed_by text content","added_at_ms":1000000,"process_at_ms":1000000,"processed_at_ms":1000000,"finished_at_ms":1000000,"lock_token":"Sample lock_token text content","locked_until_ms":1000000,"stalled_count":10,"dedup_id":1,"scheduler_id":1,"parent_queue":"Sample parent_queue text content","parent_id":1,"parent_key":"Sample parent_key text content","pending_deps":"example_pending_deps","stalled_marked":"example_stalled_marked"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Jobs (Userspace)"],"summary":"Retry","description":"Retry","operationId":"jobsUserspaceRetry","parameters":[{"in":"path","name":"queue","description":"Queue identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/jobsUserspaceInput"},"example":{"queue":"Sample queue text content","seq":1000000,"name":"Example Name","state":"example_state","data":"example_data","opts":"example_opts","priority":"example_priority","delay_ms":1000000,"max_attempts":"example_max_attempts","attempts_made":"example_attempts_made","attempts_started":"example_attempts_started","progress":"example_progress","return_value":"example_return_value","failed_reason":"Sample failed_reason text content","stacktrace":"example_stacktrace","deferred_failure":"Sample deferred_failure text content","processed_by":"Sample processed_by text content","added_at_ms":1000000,"process_at_ms":1000000,"processed_at_ms":1000000,"finished_at_ms":1000000,"lock_token":"Sample lock_token text content","locked_until_ms":1000000,"stalled_count":10,"dedup_id":1,"scheduler_id":1,"parent_queue":"Sample parent_queue text content","parent_id":1,"parent_key":"Sample parent_key text content","pending_deps":"example_pending_deps","stalled_marked":"example_stalled_marked"}}}}},"delete":{"tags":["Jobs (Userspace)"],"summary":"Delete","description":"Delete a Jobs (Userspace) record by ID.","operationId":"jobsUserspaceDelete","parameters":[{"in":"path","name":"queue","description":"Queue identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/job/{queue}/{id}/log":{"get":{"tags":["Jobs (Userspace)"],"summary":"Logs SSE","description":"Logs SSE","operationId":"jobsUserspaceLogsSse","parameters":[{"in":"path","name":"queue","description":"Queue identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/jobsUserspace"},"example":{"queue":"Sample queue text content","id":12345,"seq":1000000,"name":"Example Name","state":"example_state","data":"example_data","opts":"example_opts","priority":"example_priority","delay_ms":1000000,"max_attempts":"example_max_attempts","attempts_made":"example_attempts_made","attempts_started":"example_attempts_started","progress":"example_progress","return_value":"example_return_value","failed_reason":"Sample failed_reason text content","stacktrace":"example_stacktrace","deferred_failure":"Sample deferred_failure text content","processed_by":"Sample processed_by text content","added_at_ms":1000000,"process_at_ms":1000000,"processed_at_ms":1000000,"finished_at_ms":1000000,"lock_token":"Sample lock_token text content","locked_until_ms":1000000,"stalled_count":10,"dedup_id":1,"scheduler_id":1,"parent_queue":"Sample parent_queue text content","parent_id":1,"parent_key":"Sample parent_key text content","pending_deps":"example_pending_deps","stalled_marked":"example_stalled_marked"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/kv":{"get":{"tags":["Developer - Key Value Store"],"summary":"List","description":"Retrieve a paginated list of Developer - Key Value Store records. Supports filtering, sorting, and search.","operationId":"developerKeyValueStoreList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Developer - Key Value Store"],"summary":"Create","description":"Create a new Developer - Key Value Store record.","operationId":"developerKeyValueStoreCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/kv/cache-usage":{"get":{"tags":["Developer - Key Value Store"],"summary":"Cache Usage","description":"Cache Usage","operationId":"developerKeyValueStoreCacheUsage","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/kv/{id}":{"get":{"tags":["Developer - Key Value Store"],"summary":"Read","description":"Retrieve a single Developer - Key Value Store record by ID.","operationId":"developerKeyValueStoreRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Developer - Key Value Store"],"summary":"Update","description":"Update an existing Developer - Key Value Store record by ID.","operationId":"developerKeyValueStoreUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"delete":{"tags":["Developer - Key Value Store"],"summary":"Delete","description":"Delete a Developer - Key Value Store record by ID.","operationId":"developerKeyValueStoreDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/project":{"get":{"tags":["Project"],"summary":"List","description":"Retrieve a paginated list of Project records. Supports filtering, sorting, and search.","operationId":"projectList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/project"}},"example":[{"id":12345,"account_id":1,"name":"Example Name","description":"A detailed description of the resource","icon":"example_icon","approved":1,"anvil_mcp_api_key":"example_anvil_mcp_api_key"},{"id":12345,"account_id":1,"name":"Example Name","description":"A detailed description of the resource","icon":"example_icon","approved":1,"anvil_mcp_api_key":"example_anvil_mcp_api_key"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Project"],"summary":"Create","description":"Create a new Project record.","operationId":"projectCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/projectInput"},"example":{"account_id":1,"name":"Example Name","description":"A detailed description of the resource","icon":"example_icon","approved":1,"anvil_mcp_api_key":"example_anvil_mcp_api_key"}}}}}},"/api/cp/dev/project/{id}":{"get":{"tags":["Project"],"summary":"Read","description":"Retrieve a single Project record by ID.","operationId":"projectRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/project"},"example":{"id":12345,"account_id":1,"name":"Example Name","description":"A detailed description of the resource","icon":"example_icon","approved":1,"anvil_mcp_api_key":"example_anvil_mcp_api_key"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Project"],"summary":"Update","description":"Update an existing Project record by ID.","operationId":"projectUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/projectInput"},"example":{"account_id":1,"name":"Example Name","description":"A detailed description of the resource","icon":"example_icon","approved":1,"anvil_mcp_api_key":"example_anvil_mcp_api_key"}}}}},"delete":{"tags":["Project"],"summary":"Delete","description":"Delete a Project record by ID.","operationId":"projectDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/release":{"get":{"tags":["Setup Repo"],"summary":"List","description":"Retrieve a paginated list of Setup Repo records. Supports filtering, sorting, and search.","operationId":"setupRepoList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupRepo"}},"example":[{"id":12345,"account_id":1,"project_id":1,"version":"example_version","approved":1,"published_date":"2025-01-17T10:30:00Z","commit_message":"example_commit_message"},{"id":12345,"account_id":1,"project_id":1,"version":"example_version","approved":1,"published_date":"2025-01-17T10:30:00Z","commit_message":"example_commit_message"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dev/release/install/{id}":{"post":{"tags":["Setup Repo"],"summary":"Install","description":"Install","operationId":"setupRepoInstall","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupRepoInput"},"example":{"account_id":1,"project_id":1,"version":"example_version","approved":1,"published_date":"2025-01-17T10:30:00Z","commit_message":"example_commit_message"}}}}}},"/api/cp/dialog":{"get":{"tags":["Dialog"],"summary":"Active","description":"Active","operationId":"dialogActive","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dialog/class5":{"get":{"tags":["Dialog"],"summary":"Active Class 5","description":"Active Class 5","operationId":"dialogActiveClass5","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/dialog/{id}":{"delete":{"tags":["Dialog"],"summary":"Disconnect","description":"Disconnect","operationId":"dialogDisconnect","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/did":{"get":{"tags":["Did"],"summary":"List","description":"Retrieve a paginated list of Did records. Supports filtering, sorting, and search.","operationId":"didList","parameters":[{"in":"query","name":"rtp_mode","description":"Filter by Rtp Mode","required":false,"schema":{"type":"string","enum":["Relaxed","Strict"]}},{"in":"query","name":"p_asserted_identity","description":"Filter by P Asserted Identity","required":false,"schema":{"type":"string","enum":["default","remove"]}},{"in":"query","name":"stir_shaken_min_attest","description":"Filter by Stir Shaken Min Attest","required":false,"schema":{"type":"string","enum":["A","B","C"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/did"}},"example":[{"id":12345,"account_id":1,"customer_id":1,"provider_id":1,"did":"example_did","provider_card_id":1,"customer_card_id":1,"destination":"example_destination","destination_type":"example_destination_type","destination2":"example_destination2","destination2_type":"example_destination2_type","destination3":"example_destination3","destination3_type":"example_destination3_type","notes":"Sample notes text content","channels":123,"cps":123,"max_duration":123,"rtp_proxy":1,"rtp_mode":"Relaxed","timeout":"SIP Ping","cost":99.99,"retail":99.99,"start_date":"2025-01-17T10:30:00Z","tags":"example_tags","p_asserted_identity":"default","package_id":1,"recording":1,"transcoding":1,"created_date":"2025-01-17T10:30:00Z","assigned_date":"2025-01-17T10:30:00Z","enabled":true,"sandbox_id":1,"scriptforge_timeout":99.99,"scriptforge_timeout_action":"example_scriptforge_timeout_action","vars":"Sample vars text content","retain_display_name":1,"min_days":123,"ftc_reported":1,"rtp_codec":"example_rtp_codec","stir_shaken_min_attest":"A","spam_score":1,"ipqs":1,"flags":"example_flags","last_called":"2025-01-17T10:30:00Z","block_source_type":"example_block_source_type","spam_scout":1},{"id":12345,"account_id":1,"customer_id":1,"provider_id":1,"did":"example_did","provider_card_id":1,"customer_card_id":1,"destination":"example_destination","destination_type":"example_destination_type","destination2":"example_destination2","destination2_type":"example_destination2_type","destination3":"example_destination3","destination3_type":"example_destination3_type","notes":"Sample notes text content","channels":123,"cps":123,"max_duration":123,"rtp_proxy":1,"rtp_mode":"Relaxed","timeout":"SIP Ping","cost":99.99,"retail":99.99,"start_date":"2025-01-17T10:30:00Z","tags":"example_tags","p_asserted_identity":"default","package_id":1,"recording":1,"transcoding":1,"created_date":"2025-01-17T10:30:00Z","assigned_date":"2025-01-17T10:30:00Z","enabled":true,"sandbox_id":1,"scriptforge_timeout":99.99,"scriptforge_timeout_action":"example_scriptforge_timeout_action","vars":"Sample vars text content","retain_display_name":1,"min_days":123,"ftc_reported":1,"rtp_codec":"example_rtp_codec","stir_shaken_min_attest":"A","spam_score":1,"ipqs":1,"flags":"example_flags","last_called":"2025-01-17T10:30:00Z","block_source_type":"example_block_source_type","spam_scout":1}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/did(.{ext(csv))}":{"post":{"tags":["Did"],"summary":"Create","description":"Create a new Did record.","operationId":"didCreate","parameters":[{"in":"path","name":"ext(csv))","description":"Ext Csv identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/didInput"},"example":{"account_id":1,"customer_id":1,"provider_id":1,"did":"example_did","provider_card_id":1,"customer_card_id":1,"destination":"example_destination","destination_type":"example_destination_type","destination2":"example_destination2","destination2_type":"example_destination2_type","destination3":"example_destination3","destination3_type":"example_destination3_type","notes":"Sample notes text content","channels":123,"cps":123,"max_duration":123,"rtp_proxy":1,"rtp_mode":"Relaxed","timeout":"SIP Ping","cost":99.99,"retail":99.99,"start_date":"2025-01-17T10:30:00Z","tags":"example_tags","p_asserted_identity":"default","package_id":1,"recording":1,"transcoding":1,"created_date":"2025-01-17T10:30:00Z","assigned_date":"2025-01-17T10:30:00Z","enabled":true,"sandbox_id":1,"scriptforge_timeout":99.99,"scriptforge_timeout_action":"example_scriptforge_timeout_action","vars":"Sample vars text content","retain_display_name":1,"min_days":123,"ftc_reported":1,"rtp_codec":"example_rtp_codec","stir_shaken_min_attest":"A","spam_score":1,"ipqs":1,"flags":"example_flags","last_called":"2025-01-17T10:30:00Z","block_source_type":"example_block_source_type","spam_scout":1}}}}}},"/api/cp/did-prov":{"get":{"tags":["DID Provision"],"summary":"List","description":"Retrieve a paginated list of DID Provision records. Supports filtering, sorting, and search.","operationId":"didProvisionList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/did-prov/search":{"get":{"tags":["DID Provision"],"summary":"Search","description":"Search","operationId":"didProvisionSearch","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/did.csv":{"get":{"tags":["Did"],"summary":"CSV Download","description":"CSV Download","operationId":"didCsvDownload","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/did"},"example":{"id":12345,"account_id":1,"customer_id":1,"provider_id":1,"did":"example_did","provider_card_id":1,"customer_card_id":1,"destination":"example_destination","destination_type":"example_destination_type","destination2":"example_destination2","destination2_type":"example_destination2_type","destination3":"example_destination3","destination3_type":"example_destination3_type","notes":"Sample notes text content","channels":123,"cps":123,"max_duration":123,"rtp_proxy":1,"rtp_mode":"Relaxed","timeout":"SIP Ping","cost":99.99,"retail":99.99,"start_date":"2025-01-17T10:30:00Z","tags":"example_tags","p_asserted_identity":"default","package_id":1,"recording":1,"transcoding":1,"created_date":"2025-01-17T10:30:00Z","assigned_date":"2025-01-17T10:30:00Z","enabled":true,"sandbox_id":1,"scriptforge_timeout":99.99,"scriptforge_timeout_action":"example_scriptforge_timeout_action","vars":"Sample vars text content","retain_display_name":1,"min_days":123,"ftc_reported":1,"rtp_codec":"example_rtp_codec","stir_shaken_min_attest":"A","spam_score":1,"ipqs":1,"flags":"example_flags","last_called":"2025-01-17T10:30:00Z","block_source_type":"example_block_source_type","spam_scout":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/did/{id}":{"get":{"tags":["Did"],"summary":"Read","description":"Retrieve a single Did record by ID.","operationId":"didRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/did"},"example":{"id":12345,"account_id":1,"customer_id":1,"provider_id":1,"did":"example_did","provider_card_id":1,"customer_card_id":1,"destination":"example_destination","destination_type":"example_destination_type","destination2":"example_destination2","destination2_type":"example_destination2_type","destination3":"example_destination3","destination3_type":"example_destination3_type","notes":"Sample notes text content","channels":123,"cps":123,"max_duration":123,"rtp_proxy":1,"rtp_mode":"Relaxed","timeout":"SIP Ping","cost":99.99,"retail":99.99,"start_date":"2025-01-17T10:30:00Z","tags":"example_tags","p_asserted_identity":"default","package_id":1,"recording":1,"transcoding":1,"created_date":"2025-01-17T10:30:00Z","assigned_date":"2025-01-17T10:30:00Z","enabled":true,"sandbox_id":1,"scriptforge_timeout":99.99,"scriptforge_timeout_action":"example_scriptforge_timeout_action","vars":"Sample vars text content","retain_display_name":1,"min_days":123,"ftc_reported":1,"rtp_codec":"example_rtp_codec","stir_shaken_min_attest":"A","spam_score":1,"ipqs":1,"flags":"example_flags","last_called":"2025-01-17T10:30:00Z","block_source_type":"example_block_source_type","spam_scout":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Did"],"summary":"Update","description":"Update an existing Did record by ID.","operationId":"didUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/didInput"},"example":{"account_id":1,"customer_id":1,"provider_id":1,"did":"example_did","provider_card_id":1,"customer_card_id":1,"destination":"example_destination","destination_type":"example_destination_type","destination2":"example_destination2","destination2_type":"example_destination2_type","destination3":"example_destination3","destination3_type":"example_destination3_type","notes":"Sample notes text content","channels":123,"cps":123,"max_duration":123,"rtp_proxy":1,"rtp_mode":"Relaxed","timeout":"SIP Ping","cost":99.99,"retail":99.99,"start_date":"2025-01-17T10:30:00Z","tags":"example_tags","p_asserted_identity":"default","package_id":1,"recording":1,"transcoding":1,"created_date":"2025-01-17T10:30:00Z","assigned_date":"2025-01-17T10:30:00Z","enabled":true,"sandbox_id":1,"scriptforge_timeout":99.99,"scriptforge_timeout_action":"example_scriptforge_timeout_action","vars":"Sample vars text content","retain_display_name":1,"min_days":123,"ftc_reported":1,"rtp_codec":"example_rtp_codec","stir_shaken_min_attest":"A","spam_score":1,"ipqs":1,"flags":"example_flags","last_called":"2025-01-17T10:30:00Z","block_source_type":"example_block_source_type","spam_scout":1}}}}},"delete":{"tags":["Did"],"summary":"Delete","description":"Delete a Did record by ID.","operationId":"didDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/did/{id}/spam-score":{"get":{"tags":["Did"],"summary":"Spam Score","description":"Spam Score","operationId":"didSpamScore","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/did"},"example":{"id":12345,"account_id":1,"customer_id":1,"provider_id":1,"did":"example_did","provider_card_id":1,"customer_card_id":1,"destination":"example_destination","destination_type":"example_destination_type","destination2":"example_destination2","destination2_type":"example_destination2_type","destination3":"example_destination3","destination3_type":"example_destination3_type","notes":"Sample notes text content","channels":123,"cps":123,"max_duration":123,"rtp_proxy":1,"rtp_mode":"Relaxed","timeout":"SIP Ping","cost":99.99,"retail":99.99,"start_date":"2025-01-17T10:30:00Z","tags":"example_tags","p_asserted_identity":"default","package_id":1,"recording":1,"transcoding":1,"created_date":"2025-01-17T10:30:00Z","assigned_date":"2025-01-17T10:30:00Z","enabled":true,"sandbox_id":1,"scriptforge_timeout":99.99,"scriptforge_timeout_action":"example_scriptforge_timeout_action","vars":"Sample vars text content","retain_display_name":1,"min_days":123,"ftc_reported":1,"rtp_codec":"example_rtp_codec","stir_shaken_min_attest":"A","spam_score":1,"ipqs":1,"flags":"example_flags","last_called":"2025-01-17T10:30:00Z","block_source_type":"example_block_source_type","spam_scout":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/document":{"get":{"tags":["Document"],"summary":"List","description":"Retrieve a paginated list of Document records. Supports filtering, sorting, and search.","operationId":"documentList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/document"}},"example":[{"id":12345,"company_id":1,"dt":"2025-01-17T10:30:00Z","name":"Example Name","notes":"Sample notes text content","customer_notes":"Sample customer_notes text content","filename":"example_filename"},{"id":12345,"company_id":1,"dt":"2025-01-17T10:30:00Z","name":"Example Name","notes":"Sample notes text content","customer_notes":"Sample customer_notes text content","filename":"example_filename"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Document"],"summary":"Create","description":"Create a new Document record.","operationId":"documentCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentInput"},"example":{"company_id":1,"dt":"2025-01-17T10:30:00Z","name":"Example Name","notes":"Sample notes text content","customer_notes":"Sample customer_notes text content","filename":"example_filename"}}}}}},"/api/cp/document/{id}":{"get":{"tags":["Document"],"summary":"Read","description":"Retrieve a single Document record by ID.","operationId":"documentRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/document"},"example":{"id":12345,"company_id":1,"dt":"2025-01-17T10:30:00Z","name":"Example Name","notes":"Sample notes text content","customer_notes":"Sample customer_notes text content","filename":"example_filename"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Document"],"summary":"Update","description":"Update an existing Document record by ID.","operationId":"documentUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentInput"},"example":{"company_id":1,"dt":"2025-01-17T10:30:00Z","name":"Example Name","notes":"Sample notes text content","customer_notes":"Sample customer_notes text content","filename":"example_filename"}}}}},"delete":{"tags":["Document"],"summary":"Delete","description":"Delete a Document record by ID.","operationId":"documentDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/document/{id}/{filename}":{"get":{"tags":["Document"],"summary":"Download","description":"Download","operationId":"documentDownload","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345},{"in":"path","name":"filename","description":"Filename identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/document"},"example":{"id":12345,"company_id":1,"dt":"2025-01-17T10:30:00Z","name":"Example Name","notes":"Sample notes text content","customer_notes":"Sample customer_notes text content","filename":"example_filename"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/form-builder":{"get":{"tags":["Form Builder"],"summary":"List","description":"Retrieve a paginated list of Form Builder records. Supports filtering, sorting, and search.","operationId":"formBuilderList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/formBuilder"}},"example":[{"id":12345,"account_id":1,"name":"Example Name","placement":"example_placement","schema":"Sample schema text content","scriptforge_id":1},{"id":12345,"account_id":1,"name":"Example Name","placement":"example_placement","schema":"Sample schema text content","scriptforge_id":1}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Form Builder"],"summary":"Create","description":"Create a new Form Builder record.","operationId":"formBuilderCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/formBuilderInput"},"example":{"account_id":1,"name":"Example Name","placement":"example_placement","schema":"Sample schema text content","scriptforge_id":1}}}}}},"/api/cp/form-builder/{id}":{"get":{"tags":["Form Builder"],"summary":"Read","description":"Retrieve a single Form Builder record by ID.","operationId":"formBuilderRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/formBuilder"},"example":{"id":12345,"account_id":1,"name":"Example Name","placement":"example_placement","schema":"Sample schema text content","scriptforge_id":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Form Builder"],"summary":"Update","description":"Update an existing Form Builder record by ID.","operationId":"formBuilderUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/formBuilderInput"},"example":{"account_id":1,"name":"Example Name","placement":"example_placement","schema":"Sample schema text content","scriptforge_id":1}}}}},"delete":{"tags":["Form Builder"],"summary":"Delete","description":"Delete a Form Builder record by ID.","operationId":"formBuilderDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/graphite/g3":{"get":{"tags":["Graphite"],"summary":"G3 Stats","description":"G3 Stats","operationId":"graphiteG3Stats","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/internal-number-block":{"get":{"tags":["Internal Number Block"],"summary":"List","description":"Retrieve a paginated list of Internal Number Block records. Supports filtering, sorting, and search.","operationId":"internalNumberBlockList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/internalNumberBlock"}},"example":[{"id":12345,"account_id":1,"company_id":1,"start_block":123,"end_block":123},{"id":12345,"account_id":1,"company_id":1,"start_block":123,"end_block":123}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Internal Number Block"],"summary":"Create","description":"Create a new Internal Number Block record.","operationId":"internalNumberBlockCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/internalNumberBlockInput"},"example":{"account_id":1,"company_id":1,"start_block":123,"end_block":123}}}}}},"/api/cp/internal-number-block/{id}":{"get":{"tags":["Internal Number Block"],"summary":"Read","description":"Retrieve a single Internal Number Block record by ID.","operationId":"internalNumberBlockRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/internalNumberBlock"},"example":{"id":12345,"account_id":1,"company_id":1,"start_block":123,"end_block":123}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Internal Number Block"],"summary":"Update","description":"Update an existing Internal Number Block record by ID.","operationId":"internalNumberBlockUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/internalNumberBlockInput"},"example":{"account_id":1,"company_id":1,"start_block":123,"end_block":123}}}}},"delete":{"tags":["Internal Number Block"],"summary":"Delete","description":"Delete a Internal Number Block record by ID.","operationId":"internalNumberBlockDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/invoice":{"get":{"tags":["Invoice"],"summary":"List","description":"Retrieve a paginated list of Invoice records. Supports filtering, sorting, and search.","operationId":"invoiceList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/invoice"}},"example":[{"id":12345,"account_id":1,"invoice_id":1,"company_id":1,"to_address":"example_to_address","invoice_date":"2025-01-17T10:30:00Z","sent":1,"external_id":1},{"id":12345,"account_id":1,"invoice_id":1,"company_id":1,"to_address":"example_to_address","invoice_date":"2025-01-17T10:30:00Z","sent":1,"external_id":1}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Invoice"],"summary":"Create","description":"Create a new Invoice record.","operationId":"invoiceCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoiceInput"},"example":{"account_id":1,"invoice_id":1,"company_id":1,"to_address":"example_to_address","invoice_date":"2025-01-17T10:30:00Z","sent":1,"external_id":1}}}}}},"/api/cp/invoice-line":{"get":{"tags":["Invoice Line"],"summary":"List","description":"Retrieve a paginated list of Invoice Line records. Supports filtering, sorting, and search.","operationId":"invoiceLineList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/invoiceLine"}},"example":[{"id":12345,"invoice_id":1,"qty":123,"package_id":1,"description":"A detailed description of the resource","start_date":"2025-01-17T10:30:00Z","end_date":"2025-01-17T10:30:00Z","unit_price":99.99,"net":99.99,"tax":99.99,"sub_total":10,"attempts":123,"connected":123,"duration":123,"json":"Sample json text content"},{"id":12345,"invoice_id":1,"qty":123,"package_id":1,"description":"A detailed description of the resource","start_date":"2025-01-17T10:30:00Z","end_date":"2025-01-17T10:30:00Z","unit_price":99.99,"net":99.99,"tax":99.99,"sub_total":10,"attempts":123,"connected":123,"duration":123,"json":"Sample json text content"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Invoice Line"],"summary":"Create","description":"Create a new Invoice Line record.","operationId":"invoiceLineCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoiceLineInput"},"example":{"invoice_id":1,"qty":123,"package_id":1,"description":"A detailed description of the resource","start_date":"2025-01-17T10:30:00Z","end_date":"2025-01-17T10:30:00Z","unit_price":99.99,"net":99.99,"tax":99.99,"sub_total":10,"attempts":123,"connected":123,"duration":123,"json":"Sample json text content"}}}}}},"/api/cp/invoice-line/{id}":{"get":{"tags":["Invoice Line"],"summary":"Read","description":"Retrieve a single Invoice Line record by ID.","operationId":"invoiceLineRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoiceLine"},"example":{"id":12345,"invoice_id":1,"qty":123,"package_id":1,"description":"A detailed description of the resource","start_date":"2025-01-17T10:30:00Z","end_date":"2025-01-17T10:30:00Z","unit_price":99.99,"net":99.99,"tax":99.99,"sub_total":10,"attempts":123,"connected":123,"duration":123,"json":"Sample json text content"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Invoice Line"],"summary":"Update","description":"Update an existing Invoice Line record by ID.","operationId":"invoiceLineUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoiceLineInput"},"example":{"invoice_id":1,"qty":123,"package_id":1,"description":"A detailed description of the resource","start_date":"2025-01-17T10:30:00Z","end_date":"2025-01-17T10:30:00Z","unit_price":99.99,"net":99.99,"tax":99.99,"sub_total":10,"attempts":123,"connected":123,"duration":123,"json":"Sample json text content"}}}}},"delete":{"tags":["Invoice Line"],"summary":"Delete","description":"Delete a Invoice Line record by ID.","operationId":"invoiceLineDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/invoice-payment":{"get":{"tags":["Invoice Payment"],"summary":"List","description":"Retrieve a paginated list of Invoice Payment records. Supports filtering, sorting, and search.","operationId":"invoicePaymentList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/invoicePayment"}},"example":[{"id":12345,"invoice_id":1,"payment_id":1,"total":10},{"id":12345,"invoice_id":1,"payment_id":1,"total":10}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Invoice Payment"],"summary":"Create","description":"Create a new Invoice Payment record.","operationId":"invoicePaymentCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoicePaymentInput"},"example":{"invoice_id":1,"payment_id":1,"total":10}}}}}},"/api/cp/invoice-payment/{id}":{"delete":{"tags":["Invoice Payment"],"summary":"Delete","description":"Delete a Invoice Payment record by ID.","operationId":"invoicePaymentDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/invoice/billed":{"get":{"tags":["Invoice"],"summary":"Billed","description":"Billed","operationId":"invoiceBilled","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoice"},"example":{"id":12345,"account_id":1,"invoice_id":1,"company_id":1,"to_address":"example_to_address","invoice_date":"2025-01-17T10:30:00Z","sent":1,"external_id":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/invoice/generate":{"post":{"tags":["Invoice"],"summary":"Generate","description":"Generate","operationId":"invoiceGenerate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoiceInput"},"example":{"account_id":1,"invoice_id":1,"company_id":1,"to_address":"example_to_address","invoice_date":"2025-01-17T10:30:00Z","sent":1,"external_id":1}}}}}},"/api/cp/invoice/{id.html}":{"get":{"tags":["Invoice"],"summary":"HTML","description":"HTML","operationId":"invoiceHtml","parameters":[{"in":"path","name":"id.html","description":"Id Html identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoice"},"example":{"id":12345,"account_id":1,"invoice_id":1,"company_id":1,"to_address":"example_to_address","invoice_date":"2025-01-17T10:30:00Z","sent":1,"external_id":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/invoice/{id.pdf}":{"get":{"tags":["Invoice"],"summary":"PDF","description":"PDF","operationId":"invoicePdf","parameters":[{"in":"path","name":"id.pdf","description":"Id Pdf identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoice"},"example":{"id":12345,"account_id":1,"invoice_id":1,"company_id":1,"to_address":"example_to_address","invoice_date":"2025-01-17T10:30:00Z","sent":1,"external_id":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/invoice/{id}":{"get":{"tags":["Invoice"],"summary":"Read","description":"Retrieve a single Invoice record by ID.","operationId":"invoiceRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoice"},"example":{"id":12345,"account_id":1,"invoice_id":1,"company_id":1,"to_address":"example_to_address","invoice_date":"2025-01-17T10:30:00Z","sent":1,"external_id":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Invoice"],"summary":"Update","description":"Update an existing Invoice record by ID.","operationId":"invoiceUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoiceInput"},"example":{"account_id":1,"invoice_id":1,"company_id":1,"to_address":"example_to_address","invoice_date":"2025-01-17T10:30:00Z","sent":1,"external_id":1}}}}},"delete":{"tags":["Invoice"],"summary":"Delete","description":"Delete a Invoice record by ID.","operationId":"invoiceDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/lang":{"get":{"tags":["Lang"],"summary":"List","description":"Retrieve a paginated list of Lang records. Supports filtering, sorting, and search.","operationId":"langList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/lang/{lang.json}":{"get":{"tags":["Lang"],"summary":"Language","description":"Language","operationId":"langLanguage","parameters":[{"in":"path","name":"lang.json","description":"Lang Json identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/log":{"get":{"tags":["Log"],"summary":"Log","description":"Log","operationId":"logLog","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/log/c4log":{"get":{"tags":["Log"],"summary":"Class 4 Log","description":"Class 4 Log","operationId":"logClass4Log","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/log/class5":{"get":{"tags":["Log"],"summary":"Class 5","description":"Class 5","operationId":"logClass5","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/log/class5simulate":{"post":{"tags":["Log"],"summary":"Class 5 Simulate","description":"Class 5 Simulate","operationId":"logClass5Simulate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/log/converse":{"get":{"tags":["Log"],"summary":"Converse","description":"Converse","operationId":"logConverse","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/log/fraud":{"get":{"tags":["Log"],"summary":"Fraud","description":"Fraud","operationId":"logFraud","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/log/nanpa-sp/{spid}":{"get":{"tags":["Log"],"summary":"NANPA Service Providers","description":"NANPA Service Providers","operationId":"logNanpaServiceProviders","parameters":[{"in":"path","name":"spid","description":"Spid identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/log/register":{"get":{"tags":["Log"],"summary":"Register","description":"Register","operationId":"logRegister","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/log/rtcp":{"get":{"tags":["Log"],"summary":"RTCP","description":"RTCP","operationId":"logRtcp","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/log/scout":{"get":{"tags":["Log"],"summary":"Scout Lookup","description":"Scout Lookup","operationId":"logScoutLookup","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/log/simulate":{"post":{"tags":["Log"],"summary":"Simulate","description":"Simulate","operationId":"logSimulate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/log/system":{"socket":{"tags":["Log"],"summary":"System","description":"System","operationId":"logSystem","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/log/trace(.{ext(txt|pcap))}":{"get":{"tags":["Log"],"summary":"SIP Trace","description":"SIP Trace","operationId":"logSipTrace","parameters":[{"in":"path","name":"ext(txt|pcap))","description":"Ext Txt Pcap identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/lookup/asrplus/{number}":{"get":{"tags":["Lookup"],"summary":"ASR Plus Lookup","description":"ASR Plus Lookup","operationId":"lookupAsrPlusLookup","parameters":[{"in":"path","name":"number","description":"Number identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lookup"},"example":{"country":"US","iso3166_3":"example_iso3166_3","iso3166_2":"example_iso3166_2","idd":"example_idd","prefix":"example_prefix","cc":"example_cc","ndc1":"example_ndc1","ndc1t":"example_ndc1t","ndc2":"example_ndc2","sn1":"example_sn1","sn1t":"example_sn1t","sn2":"example_sn2","snl":"example_snl","description":"A detailed description of the resource","type":"example_type","test_numbers":"example_test_numbers","start_date":"2025-01-17T10:30:00Z","end_date":"2025-01-17T10:30:00Z","last_update":"2025-01-17","net_name":"example_net_name","net_type":"example_net_type","mcc":"example_mcc","mnc":"example_mnc","tadig_nc":"example_tadig_nc","handset_code":"example_handset_code","net_start_date":"2025-01-17T10:30:00Z","net_end_date":"2025-01-17T10:30:00Z","operator":"example_operator","licensed_service_areas":"example_licensed_service_areas","country_notes":10,"nop_notes":"example_nop_notes","net_notes":"example_net_notes","prefix_notes":"example_prefix_notes","row_insertion_date":"2025-01-17T10:30:00Z"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/lookup/country":{"get":{"tags":["Lookup"],"summary":"Country","description":"Country","operationId":"lookupCountry","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lookup"},"example":{"country":"US","iso3166_3":"example_iso3166_3","iso3166_2":"example_iso3166_2","idd":"example_idd","prefix":"example_prefix","cc":"example_cc","ndc1":"example_ndc1","ndc1t":"example_ndc1t","ndc2":"example_ndc2","sn1":"example_sn1","sn1t":"example_sn1t","sn2":"example_sn2","snl":"example_snl","description":"A detailed description of the resource","type":"example_type","test_numbers":"example_test_numbers","start_date":"2025-01-17T10:30:00Z","end_date":"2025-01-17T10:30:00Z","last_update":"2025-01-17","net_name":"example_net_name","net_type":"example_net_type","mcc":"example_mcc","mnc":"example_mnc","tadig_nc":"example_tadig_nc","handset_code":"example_handset_code","net_start_date":"2025-01-17T10:30:00Z","net_end_date":"2025-01-17T10:30:00Z","operator":"example_operator","licensed_service_areas":"example_licensed_service_areas","country_notes":10,"nop_notes":"example_nop_notes","net_notes":"example_net_notes","prefix_notes":"example_prefix_notes","row_insertion_date":"2025-01-17T10:30:00Z"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/lookup/inp/{number}":{"get":{"tags":["Lookup"],"summary":"INP","description":"INP","operationId":"lookupInp","parameters":[{"in":"path","name":"number","description":"Number identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lookup"},"example":{"country":"US","iso3166_3":"example_iso3166_3","iso3166_2":"example_iso3166_2","idd":"example_idd","prefix":"example_prefix","cc":"example_cc","ndc1":"example_ndc1","ndc1t":"example_ndc1t","ndc2":"example_ndc2","sn1":"example_sn1","sn1t":"example_sn1t","sn2":"example_sn2","snl":"example_snl","description":"A detailed description of the resource","type":"example_type","test_numbers":"example_test_numbers","start_date":"2025-01-17T10:30:00Z","end_date":"2025-01-17T10:30:00Z","last_update":"2025-01-17","net_name":"example_net_name","net_type":"example_net_type","mcc":"example_mcc","mnc":"example_mnc","tadig_nc":"example_tadig_nc","handset_code":"example_handset_code","net_start_date":"2025-01-17T10:30:00Z","net_end_date":"2025-01-17T10:30:00Z","operator":"example_operator","licensed_service_areas":"example_licensed_service_areas","country_notes":10,"nop_notes":"example_nop_notes","net_notes":"example_net_notes","prefix_notes":"example_prefix_notes","row_insertion_date":"2025-01-17T10:30:00Z"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/lookup/ip/{ip}":{"get":{"tags":["Lookup"],"summary":"IP Lookup","description":"IP Lookup","operationId":"lookupIpLookup","parameters":[{"in":"path","name":"ip","description":"Ip identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lookup"},"example":{"country":"US","iso3166_3":"example_iso3166_3","iso3166_2":"example_iso3166_2","idd":"example_idd","prefix":"example_prefix","cc":"example_cc","ndc1":"example_ndc1","ndc1t":"example_ndc1t","ndc2":"example_ndc2","sn1":"example_sn1","sn1t":"example_sn1t","sn2":"example_sn2","snl":"example_snl","description":"A detailed description of the resource","type":"example_type","test_numbers":"example_test_numbers","start_date":"2025-01-17T10:30:00Z","end_date":"2025-01-17T10:30:00Z","last_update":"2025-01-17","net_name":"example_net_name","net_type":"example_net_type","mcc":"example_mcc","mnc":"example_mnc","tadig_nc":"example_tadig_nc","handset_code":"example_handset_code","net_start_date":"2025-01-17T10:30:00Z","net_end_date":"2025-01-17T10:30:00Z","operator":"example_operator","licensed_service_areas":"example_licensed_service_areas","country_notes":10,"nop_notes":"example_nop_notes","net_notes":"example_net_notes","prefix_notes":"example_prefix_notes","row_insertion_date":"2025-01-17T10:30:00Z"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/lookup/ipqs/{number}":{"get":{"tags":["Lookup"],"summary":"IPQS Spam Score","description":"IPQS Spam Score","operationId":"lookupIpqsSpamScore","parameters":[{"in":"path","name":"number","description":"Number identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lookup"},"example":{"country":"US","iso3166_3":"example_iso3166_3","iso3166_2":"example_iso3166_2","idd":"example_idd","prefix":"example_prefix","cc":"example_cc","ndc1":"example_ndc1","ndc1t":"example_ndc1t","ndc2":"example_ndc2","sn1":"example_sn1","sn1t":"example_sn1t","sn2":"example_sn2","snl":"example_snl","description":"A detailed description of the resource","type":"example_type","test_numbers":"example_test_numbers","start_date":"2025-01-17T10:30:00Z","end_date":"2025-01-17T10:30:00Z","last_update":"2025-01-17","net_name":"example_net_name","net_type":"example_net_type","mcc":"example_mcc","mnc":"example_mnc","tadig_nc":"example_tadig_nc","handset_code":"example_handset_code","net_start_date":"2025-01-17T10:30:00Z","net_end_date":"2025-01-17T10:30:00Z","operator":"example_operator","licensed_service_areas":"example_licensed_service_areas","country_notes":10,"nop_notes":"example_nop_notes","net_notes":"example_net_notes","prefix_notes":"example_prefix_notes","row_insertion_date":"2025-01-17T10:30:00Z"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/lookup/spam-scout/{number}":{"get":{"tags":["Lookup"],"summary":"Spam Scout","description":"Spam Scout","operationId":"lookupSpamScout","parameters":[{"in":"path","name":"number","description":"Number identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lookup"},"example":{"country":"US","iso3166_3":"example_iso3166_3","iso3166_2":"example_iso3166_2","idd":"example_idd","prefix":"example_prefix","cc":"example_cc","ndc1":"example_ndc1","ndc1t":"example_ndc1t","ndc2":"example_ndc2","sn1":"example_sn1","sn1t":"example_sn1t","sn2":"example_sn2","snl":"example_snl","description":"A detailed description of the resource","type":"example_type","test_numbers":"example_test_numbers","start_date":"2025-01-17T10:30:00Z","end_date":"2025-01-17T10:30:00Z","last_update":"2025-01-17","net_name":"example_net_name","net_type":"example_net_type","mcc":"example_mcc","mnc":"example_mnc","tadig_nc":"example_tadig_nc","handset_code":"example_handset_code","net_start_date":"2025-01-17T10:30:00Z","net_end_date":"2025-01-17T10:30:00Z","operator":"example_operator","licensed_service_areas":"example_licensed_service_areas","country_notes":10,"nop_notes":"example_nop_notes","net_notes":"example_net_notes","prefix_notes":"example_prefix_notes","row_insertion_date":"2025-01-17T10:30:00Z"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/mcp":{"get":{"tags":["MCP Proxy"],"summary":"MCP SSE Endpoint","description":"MCP SSE Endpoint","operationId":"mcpProxyMcpSseEndpoint","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["MCP Proxy"],"summary":"Default MCP Proxy Endpoint","description":"Default MCP Proxy Endpoint","operationId":"mcpProxyDefaultMcpProxyEndpoint","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/mcp/{id}":{"get":{"tags":["MCP Proxy"],"summary":"Anvil MCP Proxy Endpoint (GET)","description":"Anvil MCP Proxy Endpoint (GET)","operationId":"mcpProxyAnvilMcpProxyEndpointGet","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["MCP Proxy"],"summary":"Anvil MCP Proxy Endpoint (POST)","description":"Anvil MCP Proxy Endpoint (POST)","operationId":"mcpProxyAnvilMcpProxyEndpointPost","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/metricsql/label/{name}/values":{"get":{"tags":["MetricsQL"],"summary":"Label Values","description":"Label Values","operationId":"metricsQlLabelValues","parameters":[{"in":"path","name":"name","description":"Name identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/metricsql/labels":{"get":{"tags":["MetricsQL"],"summary":"Labels","description":"Labels","operationId":"metricsQlLabels","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/metricsql/query":{"get":{"tags":["MetricsQL"],"summary":"Instant Query","description":"Instant Query","operationId":"metricsQlInstantQuery","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/metricsql/query_range":{"get":{"tags":["MetricsQL"],"summary":"Range Query","description":"Range Query","operationId":"metricsQlRangeQuery","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/metricsql/series":{"get":{"tags":["MetricsQL"],"summary":"Series","description":"Series","operationId":"metricsQlSeries","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/neutrafix":{"get":{"tags":["Neutrafix"],"summary":"List","description":"Retrieve a paginated list of Neutrafix records. Supports filtering, sorting, and search.","operationId":"neutrafixList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/neutrafix/signup":{"post":{"tags":["Neutrafix"],"summary":"Signup","description":"Signup","operationId":"neutrafixSignup","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/package":{"get":{"tags":["Package"],"summary":"List","description":"Retrieve a paginated list of Package records. Supports filtering, sorting, and search.","operationId":"packageList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/package"}},"example":[{"id":12345,"account_id":1,"company_id":1,"package_id":1,"st":"2025-01-17T10:30:00Z","et":"2025-01-17T10:30:00Z","qty":123,"auto_decrement_credit":1,"balance":99.99,"minutes":99.99,"min_days":123},{"id":12345,"account_id":1,"company_id":1,"package_id":1,"st":"2025-01-17T10:30:00Z","et":"2025-01-17T10:30:00Z","qty":123,"auto_decrement_credit":1,"balance":99.99,"minutes":99.99,"min_days":123}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Package"],"summary":"Create","description":"Create a new Package record.","operationId":"packageCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/packageInput"},"example":{"account_id":1,"company_id":1,"package_id":1,"st":"2025-01-17T10:30:00Z","et":"2025-01-17T10:30:00Z","qty":123,"auto_decrement_credit":1,"balance":99.99,"minutes":99.99,"min_days":123}}}}}},"/api/cp/package/run":{"post":{"tags":["Package"],"summary":"Run","description":"Run","operationId":"packageRun","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/packageInput"},"example":{"account_id":1,"company_id":1,"package_id":1,"st":"2025-01-17T10:30:00Z","et":"2025-01-17T10:30:00Z","qty":123,"auto_decrement_credit":1,"balance":99.99,"minutes":99.99,"min_days":123}}}}}},"/api/cp/package/{id}":{"get":{"tags":["Package"],"summary":"Read","description":"Retrieve a single Package record by ID.","operationId":"packageRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/package"},"example":{"id":12345,"account_id":1,"company_id":1,"package_id":1,"st":"2025-01-17T10:30:00Z","et":"2025-01-17T10:30:00Z","qty":123,"auto_decrement_credit":1,"balance":99.99,"minutes":99.99,"min_days":123}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Package"],"summary":"Update","description":"Update an existing Package record by ID.","operationId":"packageUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/packageInput"},"example":{"account_id":1,"company_id":1,"package_id":1,"st":"2025-01-17T10:30:00Z","et":"2025-01-17T10:30:00Z","qty":123,"auto_decrement_credit":1,"balance":99.99,"minutes":99.99,"min_days":123}}}}},"delete":{"tags":["Package"],"summary":"Delete","description":"Delete a Package record by ID.","operationId":"packageDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/page/{id}":{"get":{"tags":["Setup Page"],"summary":"System Apps","description":"System Apps","operationId":"setupPageSystemApps","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupPage"},"example":{"id":12345,"account_id":1,"app_id":1,"name":"Example Name","title":"Example Name","data":"Sample data text content"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/payment":{"post":{"tags":["Payment"],"summary":"Create","description":"Create a new Payment record.","operationId":"paymentCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paymentInput"},"example":{"company_id":1,"payment_time":"2025-01-17T10:30:00Z","description":"A detailed description of the resource","total":10,"tax_rate":99.99,"invoice_id":1,"currency":"USD","override_xe":1.5,"payment_fee":99.99,"status":"Completed","payment_id":1,"charge_id":1,"reconciliation_id":1,"tax_paid":99.99}}}}}},"/api/cp/payment(.{ext(csv))}":{"get":{"tags":["Payment"],"summary":"List","description":"Retrieve a paginated list of Payment records. Supports filtering, sorting, and search.","operationId":"paymentList","parameters":[{"in":"path","name":"ext(csv))","description":"Ext Csv identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"query","name":"status","description":"Filter by Status","required":false,"schema":{"type":"string","enum":["Completed","Pending","Canceled"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/payment"}},"example":[{"id":12345,"company_id":1,"payment_time":"2025-01-17T10:30:00Z","description":"A detailed description of the resource","total":10,"tax_rate":99.99,"invoice_id":1,"currency":"USD","override_xe":1.5,"payment_fee":99.99,"status":"Completed","payment_id":1,"charge_id":1,"reconciliation_id":1,"tax_paid":99.99},{"id":12345,"company_id":1,"payment_time":"2025-01-17T10:30:00Z","description":"A detailed description of the resource","total":10,"tax_rate":99.99,"invoice_id":1,"currency":"USD","override_xe":1.5,"payment_fee":99.99,"status":"Completed","payment_id":1,"charge_id":1,"reconciliation_id":1,"tax_paid":99.99}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/payment/{id}":{"get":{"tags":["Payment"],"summary":"Read","description":"Retrieve a single Payment record by ID.","operationId":"paymentRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment"},"example":{"id":12345,"company_id":1,"payment_time":"2025-01-17T10:30:00Z","description":"A detailed description of the resource","total":10,"tax_rate":99.99,"invoice_id":1,"currency":"USD","override_xe":1.5,"payment_fee":99.99,"status":"Completed","payment_id":1,"charge_id":1,"reconciliation_id":1,"tax_paid":99.99}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Payment"],"summary":"Update","description":"Update an existing Payment record by ID.","operationId":"paymentUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paymentInput"},"example":{"company_id":1,"payment_time":"2025-01-17T10:30:00Z","description":"A detailed description of the resource","total":10,"tax_rate":99.99,"invoice_id":1,"currency":"USD","override_xe":1.5,"payment_fee":99.99,"status":"Completed","payment_id":1,"charge_id":1,"reconciliation_id":1,"tax_paid":99.99}}}}},"delete":{"tags":["Payment"],"summary":"Delete","description":"Delete a Payment record by ID.","operationId":"paymentDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/phonebook":{"get":{"tags":["Phonebook"],"summary":"List","description":"Retrieve a paginated list of Phonebook records. Supports filtering, sorting, and search.","operationId":"phonebookList","parameters":[{"in":"query","name":"type","description":"Filter by Type","required":false,"schema":{"type":"string"}},{"in":"query","name":"category","description":"Filter by Category","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/phonebook"}},"example":[{"id":12345,"company_id":1,"username":"john_doe","organization":"example_organization","name_given":"example_name_given","name_family":"example_name_family","type":"example_type","category":"example_category"},{"id":12345,"company_id":1,"username":"john_doe","organization":"example_organization","name_given":"example_name_given","name_family":"example_name_family","type":"example_type","category":"example_category"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Phonebook"],"summary":"Create","description":"Create a new Phonebook record.","operationId":"phonebookCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/phonebookInput"},"example":{"company_id":1,"username":"john_doe","organization":"example_organization","name_given":"example_name_given","name_family":"example_name_family","type":"example_type","category":"example_category"}}}}}},"/api/cp/phonebook-phone":{"get":{"tags":["Phonebook Phone"],"summary":"List","description":"Retrieve a paginated list of Phonebook Phone records. Supports filtering, sorting, and search.","operationId":"phonebookPhoneList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/phonebookPhone"}},"example":[{"id":12345,"phonebook_id":1,"label":"example_label","number":"example_number","extension":"example_extension","primary":"example_primary"},{"id":12345,"phonebook_id":1,"label":"example_label","number":"example_number","extension":"example_extension","primary":"example_primary"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Phonebook Phone"],"summary":"Create","description":"Create a new Phonebook Phone record.","operationId":"phonebookPhoneCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/phonebookPhoneInput"},"example":{"phonebook_id":1,"label":"example_label","number":"example_number","extension":"example_extension","primary":"example_primary"}}}}}},"/api/cp/phonebook-phone/{id}":{"get":{"tags":["Phonebook Phone"],"summary":"Read","description":"Retrieve a single Phonebook Phone record by ID.","operationId":"phonebookPhoneRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/phonebookPhone"},"example":{"id":12345,"phonebook_id":1,"label":"example_label","number":"example_number","extension":"example_extension","primary":"example_primary"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Phonebook Phone"],"summary":"Update","description":"Update an existing Phonebook Phone record by ID.","operationId":"phonebookPhoneUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/phonebookPhoneInput"},"example":{"phonebook_id":1,"label":"example_label","number":"example_number","extension":"example_extension","primary":"example_primary"}}}}},"delete":{"tags":["Phonebook Phone"],"summary":"Delete","description":"Delete a Phonebook Phone record by ID.","operationId":"phonebookPhoneDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/phonebook/{id}":{"get":{"tags":["Phonebook"],"summary":"Read","description":"Retrieve a single Phonebook record by ID.","operationId":"phonebookRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/phonebook"},"example":{"id":12345,"company_id":1,"username":"john_doe","organization":"example_organization","name_given":"example_name_given","name_family":"example_name_family","type":"example_type","category":"example_category"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Phonebook"],"summary":"Update","description":"Update an existing Phonebook record by ID.","operationId":"phonebookUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/phonebookInput"},"example":{"company_id":1,"username":"john_doe","organization":"example_organization","name_given":"example_name_given","name_family":"example_name_family","type":"example_type","category":"example_category"}}}}},"delete":{"tags":["Phonebook"],"summary":"Delete","description":"Delete a Phonebook record by ID.","operationId":"phonebookDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/recording/check/{customer_id}/{date}/{callid}":{"get":{"tags":["Recording"],"summary":"Check","description":"Check","operationId":"recordingCheck","parameters":[{"in":"path","name":"customer_id","description":"Customer Id identifier","required":true,"schema":{"type":"integer"},"example":12345},{"in":"path","name":"date","description":"Date identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"callid","description":"Callid identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/recording/download/{customer_id}/{date}/{callid}":{"get":{"tags":["Recording"],"summary":"Download","description":"Download","operationId":"recordingDownload","parameters":[{"in":"path","name":"customer_id","description":"Customer Id identifier","required":true,"schema":{"type":"integer"},"example":12345},{"in":"path","name":"date","description":"Date identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"callid","description":"Callid identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/regex-generate":{"post":{"tags":["Regex Generate"],"summary":"Generate","description":"Generate","operationId":"regexGenerateGenerate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/report-schedule":{"get":{"tags":["Report Schedule"],"summary":"List","description":"Retrieve a paginated list of Report Schedule records. Supports filtering, sorting, and search.","operationId":"reportScheduleList","parameters":[{"in":"query","name":"frequency","description":"Filter by Frequency","required":false,"schema":{"type":"string","enum":["day","week","month"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/reportSchedule"}},"example":[{"id":12345,"account_id":1,"name":"Example Name","email":"user@example.com","frequency":"day","query":"Sample query text content"},{"id":12345,"account_id":1,"name":"Example Name","email":"user@example.com","frequency":"day","query":"Sample query text content"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Report Schedule"],"summary":"Create","description":"Create a new Report Schedule record.","operationId":"reportScheduleCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportScheduleInput"},"example":{"account_id":1,"name":"Example Name","email":"user@example.com","frequency":"day","query":"Sample query text content"}}}}}},"/api/cp/report-schedule/{id}":{"get":{"tags":["Report Schedule"],"summary":"Read","description":"Retrieve a single Report Schedule record by ID.","operationId":"reportScheduleRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportSchedule"},"example":{"id":12345,"account_id":1,"name":"Example Name","email":"user@example.com","frequency":"day","query":"Sample query text content"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Report Schedule"],"summary":"Update","description":"Update an existing Report Schedule record by ID.","operationId":"reportScheduleUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportScheduleInput"},"example":{"account_id":1,"name":"Example Name","email":"user@example.com","frequency":"day","query":"Sample query text content"}}}}},"delete":{"tags":["Report Schedule"],"summary":"Delete","description":"Delete a Report Schedule record by ID.","operationId":"reportScheduleDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/report-schedule/{id}/send":{"post":{"tags":["Report Schedule"],"summary":"Email","description":"Email","operationId":"reportScheduleEmail","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportScheduleInput"},"example":{"account_id":1,"name":"Example Name","email":"user@example.com","frequency":"day","query":"Sample query text content"}}}}}},"/api/cp/rev":{"get":{"tags":["Rev"],"summary":"List","description":"Retrieve a paginated list of Rev records. Supports filtering, sorting, and search.","operationId":"revList","parameters":[{"in":"query","name":"rounding_method","description":"Filter by Rounding Method","required":false,"schema":{"type":"string","enum":["up","down","half-up","half-down"]}},{"in":"query","name":"duration_rounding_method","description":"Filter by Duration Rounding Method","required":false,"schema":{"type":"string","enum":["up","down","half-up","half-down"]}},{"in":"query","name":"storage","description":"Filter by Storage","required":false,"schema":{"type":"string","enum":["live","archive","archiving","archiving-deleting","making-live"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/rev"}},"example":[{"id":12345,"card_id":1,"name":"Example Name","ts":"2025-01-17T10:30:00Z","revision":123,"presentation":"example_presentation","external":1,"expire":"2025-01-17T10:30:00Z","stale":1,"currency":"USD","date_live":"2025-01-17T10:30:00Z","count":10,"live_rev_id":1,"billing_precision":1,"rounding_method":"up","duration_rounding_method":"up","origin_billing_source":"example_origin_billing_source","origin_billing_destination":"example_origin_billing_destination","storage":"live","archiving_at":"2025-01-17T10:30:00Z","archive_rule_count":10,"archive_sha256":"example_archive_sha256","archive_size":1000000,"archive_created_at":"2025-01-17T10:30:00Z","archive_deleted_at":"2025-01-17T10:30:00Z","archive_error":"Sample archive_error text content"},{"id":12345,"card_id":1,"name":"Example Name","ts":"2025-01-17T10:30:00Z","revision":123,"presentation":"example_presentation","external":1,"expire":"2025-01-17T10:30:00Z","stale":1,"currency":"USD","date_live":"2025-01-17T10:30:00Z","count":10,"live_rev_id":1,"billing_precision":1,"rounding_method":"up","duration_rounding_method":"up","origin_billing_source":"example_origin_billing_source","origin_billing_destination":"example_origin_billing_destination","storage":"live","archiving_at":"2025-01-17T10:30:00Z","archive_rule_count":10,"archive_sha256":"example_archive_sha256","archive_size":1000000,"archive_created_at":"2025-01-17T10:30:00Z","archive_deleted_at":"2025-01-17T10:30:00Z","archive_error":"Sample archive_error text content"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Rev"],"summary":"Create","description":"Create a new Rev record.","operationId":"revCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/revInput"},"example":{"card_id":1,"name":"Example Name","ts":"2025-01-17T10:30:00Z","revision":123,"presentation":"example_presentation","external":1,"expire":"2025-01-17T10:30:00Z","stale":1,"currency":"USD","date_live":"2025-01-17T10:30:00Z","count":10,"live_rev_id":1,"billing_precision":1,"rounding_method":"up","duration_rounding_method":"up","origin_billing_source":"example_origin_billing_source","origin_billing_destination":"example_origin_billing_destination","storage":"live","archiving_at":"2025-01-17T10:30:00Z","archive_rule_count":10,"archive_sha256":"example_archive_sha256","archive_size":1000000,"archive_created_at":"2025-01-17T10:30:00Z","archive_deleted_at":"2025-01-17T10:30:00Z","archive_error":"Sample archive_error text content"}}}}}},"/api/cp/rev/{id}":{"get":{"tags":["Rev"],"summary":"Read","description":"Retrieve a single Rev record by ID.","operationId":"revRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rev"},"example":{"id":12345,"card_id":1,"name":"Example Name","ts":"2025-01-17T10:30:00Z","revision":123,"presentation":"example_presentation","external":1,"expire":"2025-01-17T10:30:00Z","stale":1,"currency":"USD","date_live":"2025-01-17T10:30:00Z","count":10,"live_rev_id":1,"billing_precision":1,"rounding_method":"up","duration_rounding_method":"up","origin_billing_source":"example_origin_billing_source","origin_billing_destination":"example_origin_billing_destination","storage":"live","archiving_at":"2025-01-17T10:30:00Z","archive_rule_count":10,"archive_sha256":"example_archive_sha256","archive_size":1000000,"archive_created_at":"2025-01-17T10:30:00Z","archive_deleted_at":"2025-01-17T10:30:00Z","archive_error":"Sample archive_error text content"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Rev"],"summary":"Update","description":"Update an existing Rev record by ID.","operationId":"revUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/revInput"},"example":{"card_id":1,"name":"Example Name","ts":"2025-01-17T10:30:00Z","revision":123,"presentation":"example_presentation","external":1,"expire":"2025-01-17T10:30:00Z","stale":1,"currency":"USD","date_live":"2025-01-17T10:30:00Z","count":10,"live_rev_id":1,"billing_precision":1,"rounding_method":"up","duration_rounding_method":"up","origin_billing_source":"example_origin_billing_source","origin_billing_destination":"example_origin_billing_destination","storage":"live","archiving_at":"2025-01-17T10:30:00Z","archive_rule_count":10,"archive_sha256":"example_archive_sha256","archive_size":1000000,"archive_created_at":"2025-01-17T10:30:00Z","archive_deleted_at":"2025-01-17T10:30:00Z","archive_error":"Sample archive_error text content"}}}}},"delete":{"tags":["Rev"],"summary":"Delete","description":"Delete a Rev record by ID.","operationId":"revDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/route-strategy":{"get":{"tags":["Route Strategy"],"summary":"List","description":"Retrieve a paginated list of Route Strategy records. Supports filtering, sorting, and search.","operationId":"routeStrategyList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/routeStrategy"}},"example":[{"id":12345,"account_id":1,"name":"Example Name","strategy":"example_strategy","cards":"example_cards","override_routing":1},{"id":12345,"account_id":1,"name":"Example Name","strategy":"example_strategy","cards":"example_cards","override_routing":1}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Route Strategy"],"summary":"Create","description":"Create a new Route Strategy record.","operationId":"routeStrategyCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/routeStrategyInput"},"example":{"account_id":1,"name":"Example Name","strategy":"example_strategy","cards":"example_cards","override_routing":1}}}}}},"/api/cp/route-strategy/{id}":{"get":{"tags":["Route Strategy"],"summary":"Read","description":"Retrieve a single Route Strategy record by ID.","operationId":"routeStrategyRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/routeStrategy"},"example":{"id":12345,"account_id":1,"name":"Example Name","strategy":"example_strategy","cards":"example_cards","override_routing":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Route Strategy"],"summary":"Update","description":"Update an existing Route Strategy record by ID.","operationId":"routeStrategyUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/routeStrategyInput"},"example":{"account_id":1,"name":"Example Name","strategy":"example_strategy","cards":"example_cards","override_routing":1}}}}},"delete":{"tags":["Route Strategy"],"summary":"Delete","description":"Delete a Route Strategy record by ID.","operationId":"routeStrategyDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/routing":{"get":{"tags":["Routing"],"summary":"List","description":"Retrieve a paginated list of Routing records. Supports filtering, sorting, and search.","operationId":"routingList","parameters":[{"in":"query","name":"rtp_mode","description":"Filter by Rtp Mode","required":false,"schema":{"type":"string","enum":["Relaxed","Strict"]}},{"in":"query","name":"protocol","description":"Filter by Protocol","required":false,"schema":{"type":"string","enum":["SIP","SMPP"]}},{"in":"query","name":"stir_shaken_min_attest","description":"Filter by Stir Shaken Min Attest","required":false,"schema":{"type":"string","enum":["A","B","C"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/routing"}},"example":[{"id":12345,"company_id":1,"card_id":1,"prefix":"example_prefix","revision":123,"channels":123,"cps":123,"cps_buffer":1,"max_duration":123,"allow_ported":1,"transcoding":1,"capped":1,"tps":1,"asr_plus":1,"recording":1,"recording_duration":123,"transcribe":1,"transcribe_duration":123,"rtp_proxy":1,"rtp_mode":"Relaxed","timeout":"SIP Ping","sip_ping":1,"rtp_timeout":1,"sip_session_timers":1,"fix_ok_cancel_race_uac_bug":1,"pre_ring_timeout":1,"post_ring_timeout":1,"fallthrough":1,"carrier_list":"example_carrier_list","dialstring":"example_dialstring","dialstring_prefix_set_id":1,"egress_group_id":1,"redirect_uri":"example_redirect_uri","redirect_exclude":"example_redirect_exclude","reply_map":"example_reply_map","capped_rate":99.99,"capped_rate_prov":99.99,"block_connect_cost":99.99,"block_destination_type":"example_block_destination_type","spam_scout":1,"ipqs":1,"override_lcr":"example_override_lcr","profit_assurance":99.99,"exclude_card":"example_exclude_card","lock_card":"example_lock_card","sandbox_id":1,"scriptforge_timeout":99.99,"scriptforge_timeout_action":"example_scriptforge_timeout_action","vars":"example_vars","protocol":"SIP","strategy":"example_strategy","remove_allow_inv":1,"approved_by":"example_approved_by","approved_date":"2025-01-17T10:30:00Z","enabled":true,"auto":1,"public_notes":"Sample public_notes text content","private_notes":"Sample private_notes text content","fraud_profile_id":1,"fraud_mode":1,"ftc_dnc_report":1,"dno":123,"inter_customer":1,"dnc_list":"example_dnc_list","block_dtmf":1,"realtime":1,"redial_max_count":10,"redial_max_period":1000,"rtp_codec":"example_rtp_codec","stir_shaken_min_attest":"A","flags":"example_flags","pbx_server":"example_pbx_server"},{"id":12345,"company_id":1,"card_id":1,"prefix":"example_prefix","revision":123,"channels":123,"cps":123,"cps_buffer":1,"max_duration":123,"allow_ported":1,"transcoding":1,"capped":1,"tps":1,"asr_plus":1,"recording":1,"recording_duration":123,"transcribe":1,"transcribe_duration":123,"rtp_proxy":1,"rtp_mode":"Relaxed","timeout":"SIP Ping","sip_ping":1,"rtp_timeout":1,"sip_session_timers":1,"fix_ok_cancel_race_uac_bug":1,"pre_ring_timeout":1,"post_ring_timeout":1,"fallthrough":1,"carrier_list":"example_carrier_list","dialstring":"example_dialstring","dialstring_prefix_set_id":1,"egress_group_id":1,"redirect_uri":"example_redirect_uri","redirect_exclude":"example_redirect_exclude","reply_map":"example_reply_map","capped_rate":99.99,"capped_rate_prov":99.99,"block_connect_cost":99.99,"block_destination_type":"example_block_destination_type","spam_scout":1,"ipqs":1,"override_lcr":"example_override_lcr","profit_assurance":99.99,"exclude_card":"example_exclude_card","lock_card":"example_lock_card","sandbox_id":1,"scriptforge_timeout":99.99,"scriptforge_timeout_action":"example_scriptforge_timeout_action","vars":"example_vars","protocol":"SIP","strategy":"example_strategy","remove_allow_inv":1,"approved_by":"example_approved_by","approved_date":"2025-01-17T10:30:00Z","enabled":true,"auto":1,"public_notes":"Sample public_notes text content","private_notes":"Sample private_notes text content","fraud_profile_id":1,"fraud_mode":1,"ftc_dnc_report":1,"dno":123,"inter_customer":1,"dnc_list":"example_dnc_list","block_dtmf":1,"realtime":1,"redial_max_count":10,"redial_max_period":1000,"rtp_codec":"example_rtp_codec","stir_shaken_min_attest":"A","flags":"example_flags","pbx_server":"example_pbx_server"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Routing"],"summary":"Create","description":"Create a new Routing record.","operationId":"routingCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/routingInput"},"example":{"company_id":1,"card_id":1,"prefix":"example_prefix","revision":123,"channels":123,"cps":123,"cps_buffer":1,"max_duration":123,"allow_ported":1,"transcoding":1,"capped":1,"tps":1,"asr_plus":1,"recording":1,"recording_duration":123,"transcribe":1,"transcribe_duration":123,"rtp_proxy":1,"rtp_mode":"Relaxed","timeout":"SIP Ping","sip_ping":1,"rtp_timeout":1,"sip_session_timers":1,"fix_ok_cancel_race_uac_bug":1,"pre_ring_timeout":1,"post_ring_timeout":1,"fallthrough":1,"carrier_list":"example_carrier_list","dialstring":"example_dialstring","dialstring_prefix_set_id":1,"egress_group_id":1,"redirect_uri":"example_redirect_uri","redirect_exclude":"example_redirect_exclude","reply_map":"example_reply_map","capped_rate":99.99,"capped_rate_prov":99.99,"block_connect_cost":99.99,"block_destination_type":"example_block_destination_type","spam_scout":1,"ipqs":1,"override_lcr":"example_override_lcr","profit_assurance":99.99,"exclude_card":"example_exclude_card","lock_card":"example_lock_card","sandbox_id":1,"scriptforge_timeout":99.99,"scriptforge_timeout_action":"example_scriptforge_timeout_action","vars":"example_vars","protocol":"SIP","strategy":"example_strategy","remove_allow_inv":1,"approved_by":"example_approved_by","approved_date":"2025-01-17T10:30:00Z","enabled":true,"auto":1,"public_notes":"Sample public_notes text content","private_notes":"Sample private_notes text content","fraud_profile_id":1,"fraud_mode":1,"ftc_dnc_report":1,"dno":123,"inter_customer":1,"dnc_list":"example_dnc_list","block_dtmf":1,"realtime":1,"redial_max_count":10,"redial_max_period":1000,"rtp_codec":"example_rtp_codec","stir_shaken_min_attest":"A","flags":"example_flags","pbx_server":"example_pbx_server"}}}}}},"/api/cp/routing-global":{"get":{"tags":["Routing Global"],"summary":"List","description":"Retrieve a paginated list of Routing Global records. Supports filtering, sorting, and search.","operationId":"routingGlobalList","parameters":[{"in":"query","name":"rtp_mode","description":"Filter by Rtp Mode","required":false,"schema":{"type":"string","enum":["Relaxed","Strict"]}},{"in":"query","name":"protocol","description":"Filter by Protocol","required":false,"schema":{"type":"string","enum":["SIP","SMPP"]}},{"in":"query","name":"stir_shaken_min_attest","description":"Filter by Stir Shaken Min Attest","required":false,"schema":{"type":"string","enum":["A","B","C"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/routingGlobal"}},"example":[{"id":12345,"account_id":1,"name":"Example Name","tag":"example_tag","card_id":1,"prefix":"example_prefix","revision":123,"channels":123,"cps":123,"cps_buffer":1,"max_duration":123,"allow_ported":1,"transcoding":1,"capped":1,"tps":1,"asr_plus":1,"recording":1,"recording_duration":123,"transcribe":1,"transcribe_duration":123,"rtp_proxy":1,"rtp_mode":"Relaxed","timeout":"SIP Ping","sip_ping":1,"rtp_timeout":1,"sip_session_timers":1,"fix_ok_cancel_race_uac_bug":1,"pre_ring_timeout":1,"post_ring_timeout":1,"fallthrough":1,"carrier_list":"example_carrier_list","dialstring":"example_dialstring","dialstring_prefix_set_id":1,"egress_group_id":1,"redirect_uri":"example_redirect_uri","redirect_exclude":"example_redirect_exclude","reply_map":"example_reply_map","capped_rate":99.99,"capped_rate_prov":99.99,"block_connect_cost":99.99,"block_destination_type":"example_block_destination_type","spam_scout":1,"ipqs":1,"override_lcr":"example_override_lcr","profit_assurance":99.99,"exclude_card":"example_exclude_card","lock_card":"example_lock_card","sandbox_id":1,"scriptforge_timeout":99.99,"scriptforge_timeout_action":"example_scriptforge_timeout_action","vars":"example_vars","protocol":"SIP","strategy":"example_strategy","remove_allow_inv":1,"approved_by":"example_approved_by","approved_date":"2025-01-17T10:30:00Z","enabled":true,"auto":1,"public_notes":"Sample public_notes text content","private_notes":"Sample private_notes text content","fraud_profile_id":1,"fraud_mode":1,"ftc_dnc_report":1,"dno":123,"inter_customer":1,"dnc_list":"example_dnc_list","block_dtmf":1,"realtime":1,"redial_max_count":10,"redial_max_period":1000,"rtp_codec":"example_rtp_codec","stir_shaken_min_attest":"A","flags":"example_flags","pbx_server":"example_pbx_server"},{"id":12345,"account_id":1,"name":"Example Name","tag":"example_tag","card_id":1,"prefix":"example_prefix","revision":123,"channels":123,"cps":123,"cps_buffer":1,"max_duration":123,"allow_ported":1,"transcoding":1,"capped":1,"tps":1,"asr_plus":1,"recording":1,"recording_duration":123,"transcribe":1,"transcribe_duration":123,"rtp_proxy":1,"rtp_mode":"Relaxed","timeout":"SIP Ping","sip_ping":1,"rtp_timeout":1,"sip_session_timers":1,"fix_ok_cancel_race_uac_bug":1,"pre_ring_timeout":1,"post_ring_timeout":1,"fallthrough":1,"carrier_list":"example_carrier_list","dialstring":"example_dialstring","dialstring_prefix_set_id":1,"egress_group_id":1,"redirect_uri":"example_redirect_uri","redirect_exclude":"example_redirect_exclude","reply_map":"example_reply_map","capped_rate":99.99,"capped_rate_prov":99.99,"block_connect_cost":99.99,"block_destination_type":"example_block_destination_type","spam_scout":1,"ipqs":1,"override_lcr":"example_override_lcr","profit_assurance":99.99,"exclude_card":"example_exclude_card","lock_card":"example_lock_card","sandbox_id":1,"scriptforge_timeout":99.99,"scriptforge_timeout_action":"example_scriptforge_timeout_action","vars":"example_vars","protocol":"SIP","strategy":"example_strategy","remove_allow_inv":1,"approved_by":"example_approved_by","approved_date":"2025-01-17T10:30:00Z","enabled":true,"auto":1,"public_notes":"Sample public_notes text content","private_notes":"Sample private_notes text content","fraud_profile_id":1,"fraud_mode":1,"ftc_dnc_report":1,"dno":123,"inter_customer":1,"dnc_list":"example_dnc_list","block_dtmf":1,"realtime":1,"redial_max_count":10,"redial_max_period":1000,"rtp_codec":"example_rtp_codec","stir_shaken_min_attest":"A","flags":"example_flags","pbx_server":"example_pbx_server"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Routing Global"],"summary":"Create","description":"Create a new Routing Global record.","operationId":"routingGlobalCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/routingGlobalInput"},"example":{"account_id":1,"name":"Example Name","tag":"example_tag","card_id":1,"prefix":"example_prefix","revision":123,"channels":123,"cps":123,"cps_buffer":1,"max_duration":123,"allow_ported":1,"transcoding":1,"capped":1,"tps":1,"asr_plus":1,"recording":1,"recording_duration":123,"transcribe":1,"transcribe_duration":123,"rtp_proxy":1,"rtp_mode":"Relaxed","timeout":"SIP Ping","sip_ping":1,"rtp_timeout":1,"sip_session_timers":1,"fix_ok_cancel_race_uac_bug":1,"pre_ring_timeout":1,"post_ring_timeout":1,"fallthrough":1,"carrier_list":"example_carrier_list","dialstring":"example_dialstring","dialstring_prefix_set_id":1,"egress_group_id":1,"redirect_uri":"example_redirect_uri","redirect_exclude":"example_redirect_exclude","reply_map":"example_reply_map","capped_rate":99.99,"capped_rate_prov":99.99,"block_connect_cost":99.99,"block_destination_type":"example_block_destination_type","spam_scout":1,"ipqs":1,"override_lcr":"example_override_lcr","profit_assurance":99.99,"exclude_card":"example_exclude_card","lock_card":"example_lock_card","sandbox_id":1,"scriptforge_timeout":99.99,"scriptforge_timeout_action":"example_scriptforge_timeout_action","vars":"example_vars","protocol":"SIP","strategy":"example_strategy","remove_allow_inv":1,"approved_by":"example_approved_by","approved_date":"2025-01-17T10:30:00Z","enabled":true,"auto":1,"public_notes":"Sample public_notes text content","private_notes":"Sample private_notes text content","fraud_profile_id":1,"fraud_mode":1,"ftc_dnc_report":1,"dno":123,"inter_customer":1,"dnc_list":"example_dnc_list","block_dtmf":1,"realtime":1,"redial_max_count":10,"redial_max_period":1000,"rtp_codec":"example_rtp_codec","stir_shaken_min_attest":"A","flags":"example_flags","pbx_server":"example_pbx_server"}}}}}},"/api/cp/routing-global/{id}":{"get":{"tags":["Routing Global"],"summary":"Read","description":"Retrieve a single Routing Global record by ID.","operationId":"routingGlobalRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/routingGlobal"},"example":{"id":12345,"account_id":1,"name":"Example Name","tag":"example_tag","card_id":1,"prefix":"example_prefix","revision":123,"channels":123,"cps":123,"cps_buffer":1,"max_duration":123,"allow_ported":1,"transcoding":1,"capped":1,"tps":1,"asr_plus":1,"recording":1,"recording_duration":123,"transcribe":1,"transcribe_duration":123,"rtp_proxy":1,"rtp_mode":"Relaxed","timeout":"SIP Ping","sip_ping":1,"rtp_timeout":1,"sip_session_timers":1,"fix_ok_cancel_race_uac_bug":1,"pre_ring_timeout":1,"post_ring_timeout":1,"fallthrough":1,"carrier_list":"example_carrier_list","dialstring":"example_dialstring","dialstring_prefix_set_id":1,"egress_group_id":1,"redirect_uri":"example_redirect_uri","redirect_exclude":"example_redirect_exclude","reply_map":"example_reply_map","capped_rate":99.99,"capped_rate_prov":99.99,"block_connect_cost":99.99,"block_destination_type":"example_block_destination_type","spam_scout":1,"ipqs":1,"override_lcr":"example_override_lcr","profit_assurance":99.99,"exclude_card":"example_exclude_card","lock_card":"example_lock_card","sandbox_id":1,"scriptforge_timeout":99.99,"scriptforge_timeout_action":"example_scriptforge_timeout_action","vars":"example_vars","protocol":"SIP","strategy":"example_strategy","remove_allow_inv":1,"approved_by":"example_approved_by","approved_date":"2025-01-17T10:30:00Z","enabled":true,"auto":1,"public_notes":"Sample public_notes text content","private_notes":"Sample private_notes text content","fraud_profile_id":1,"fraud_mode":1,"ftc_dnc_report":1,"dno":123,"inter_customer":1,"dnc_list":"example_dnc_list","block_dtmf":1,"realtime":1,"redial_max_count":10,"redial_max_period":1000,"rtp_codec":"example_rtp_codec","stir_shaken_min_attest":"A","flags":"example_flags","pbx_server":"example_pbx_server"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Routing Global"],"summary":"Update","description":"Update an existing Routing Global record by ID.","operationId":"routingGlobalUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/routingGlobalInput"},"example":{"account_id":1,"name":"Example Name","tag":"example_tag","card_id":1,"prefix":"example_prefix","revision":123,"channels":123,"cps":123,"cps_buffer":1,"max_duration":123,"allow_ported":1,"transcoding":1,"capped":1,"tps":1,"asr_plus":1,"recording":1,"recording_duration":123,"transcribe":1,"transcribe_duration":123,"rtp_proxy":1,"rtp_mode":"Relaxed","timeout":"SIP Ping","sip_ping":1,"rtp_timeout":1,"sip_session_timers":1,"fix_ok_cancel_race_uac_bug":1,"pre_ring_timeout":1,"post_ring_timeout":1,"fallthrough":1,"carrier_list":"example_carrier_list","dialstring":"example_dialstring","dialstring_prefix_set_id":1,"egress_group_id":1,"redirect_uri":"example_redirect_uri","redirect_exclude":"example_redirect_exclude","reply_map":"example_reply_map","capped_rate":99.99,"capped_rate_prov":99.99,"block_connect_cost":99.99,"block_destination_type":"example_block_destination_type","spam_scout":1,"ipqs":1,"override_lcr":"example_override_lcr","profit_assurance":99.99,"exclude_card":"example_exclude_card","lock_card":"example_lock_card","sandbox_id":1,"scriptforge_timeout":99.99,"scriptforge_timeout_action":"example_scriptforge_timeout_action","vars":"example_vars","protocol":"SIP","strategy":"example_strategy","remove_allow_inv":1,"approved_by":"example_approved_by","approved_date":"2025-01-17T10:30:00Z","enabled":true,"auto":1,"public_notes":"Sample public_notes text content","private_notes":"Sample private_notes text content","fraud_profile_id":1,"fraud_mode":1,"ftc_dnc_report":1,"dno":123,"inter_customer":1,"dnc_list":"example_dnc_list","block_dtmf":1,"realtime":1,"redial_max_count":10,"redial_max_period":1000,"rtp_codec":"example_rtp_codec","stir_shaken_min_attest":"A","flags":"example_flags","pbx_server":"example_pbx_server"}}}}},"delete":{"tags":["Routing Global"],"summary":"Delete","description":"Delete a Routing Global record by ID.","operationId":"routingGlobalDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/routing/{id}":{"get":{"tags":["Routing"],"summary":"Read","description":"Retrieve a single Routing record by ID.","operationId":"routingRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/routing"},"example":{"id":12345,"company_id":1,"card_id":1,"prefix":"example_prefix","revision":123,"channels":123,"cps":123,"cps_buffer":1,"max_duration":123,"allow_ported":1,"transcoding":1,"capped":1,"tps":1,"asr_plus":1,"recording":1,"recording_duration":123,"transcribe":1,"transcribe_duration":123,"rtp_proxy":1,"rtp_mode":"Relaxed","timeout":"SIP Ping","sip_ping":1,"rtp_timeout":1,"sip_session_timers":1,"fix_ok_cancel_race_uac_bug":1,"pre_ring_timeout":1,"post_ring_timeout":1,"fallthrough":1,"carrier_list":"example_carrier_list","dialstring":"example_dialstring","dialstring_prefix_set_id":1,"egress_group_id":1,"redirect_uri":"example_redirect_uri","redirect_exclude":"example_redirect_exclude","reply_map":"example_reply_map","capped_rate":99.99,"capped_rate_prov":99.99,"block_connect_cost":99.99,"block_destination_type":"example_block_destination_type","spam_scout":1,"ipqs":1,"override_lcr":"example_override_lcr","profit_assurance":99.99,"exclude_card":"example_exclude_card","lock_card":"example_lock_card","sandbox_id":1,"scriptforge_timeout":99.99,"scriptforge_timeout_action":"example_scriptforge_timeout_action","vars":"example_vars","protocol":"SIP","strategy":"example_strategy","remove_allow_inv":1,"approved_by":"example_approved_by","approved_date":"2025-01-17T10:30:00Z","enabled":true,"auto":1,"public_notes":"Sample public_notes text content","private_notes":"Sample private_notes text content","fraud_profile_id":1,"fraud_mode":1,"ftc_dnc_report":1,"dno":123,"inter_customer":1,"dnc_list":"example_dnc_list","block_dtmf":1,"realtime":1,"redial_max_count":10,"redial_max_period":1000,"rtp_codec":"example_rtp_codec","stir_shaken_min_attest":"A","flags":"example_flags","pbx_server":"example_pbx_server"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Routing"],"summary":"Update","description":"Update an existing Routing record by ID.","operationId":"routingUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/routingInput"},"example":{"company_id":1,"card_id":1,"prefix":"example_prefix","revision":123,"channels":123,"cps":123,"cps_buffer":1,"max_duration":123,"allow_ported":1,"transcoding":1,"capped":1,"tps":1,"asr_plus":1,"recording":1,"recording_duration":123,"transcribe":1,"transcribe_duration":123,"rtp_proxy":1,"rtp_mode":"Relaxed","timeout":"SIP Ping","sip_ping":1,"rtp_timeout":1,"sip_session_timers":1,"fix_ok_cancel_race_uac_bug":1,"pre_ring_timeout":1,"post_ring_timeout":1,"fallthrough":1,"carrier_list":"example_carrier_list","dialstring":"example_dialstring","dialstring_prefix_set_id":1,"egress_group_id":1,"redirect_uri":"example_redirect_uri","redirect_exclude":"example_redirect_exclude","reply_map":"example_reply_map","capped_rate":99.99,"capped_rate_prov":99.99,"block_connect_cost":99.99,"block_destination_type":"example_block_destination_type","spam_scout":1,"ipqs":1,"override_lcr":"example_override_lcr","profit_assurance":99.99,"exclude_card":"example_exclude_card","lock_card":"example_lock_card","sandbox_id":1,"scriptforge_timeout":99.99,"scriptforge_timeout_action":"example_scriptforge_timeout_action","vars":"example_vars","protocol":"SIP","strategy":"example_strategy","remove_allow_inv":1,"approved_by":"example_approved_by","approved_date":"2025-01-17T10:30:00Z","enabled":true,"auto":1,"public_notes":"Sample public_notes text content","private_notes":"Sample private_notes text content","fraud_profile_id":1,"fraud_mode":1,"ftc_dnc_report":1,"dno":123,"inter_customer":1,"dnc_list":"example_dnc_list","block_dtmf":1,"realtime":1,"redial_max_count":10,"redial_max_period":1000,"rtp_codec":"example_rtp_codec","stir_shaken_min_attest":"A","flags":"example_flags","pbx_server":"example_pbx_server"}}}}},"delete":{"tags":["Routing"],"summary":"Delete","description":"Delete a Routing record by ID.","operationId":"routingDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/rule":{"get":{"tags":["Rule"],"summary":"List","description":"Retrieve a paginated list of Rule records. Supports filtering, sorting, and search.","operationId":"ruleList","parameters":[{"in":"query","name":"status","description":"Filter by Status","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/rule"}},"example":[{"id":12345,"rev_id":1,"prefix":"example_prefix","name":"Example Name","cost":99.99,"intra":99.99,"inter":99.99,"peak":99.99,"evening":99.99,"weekend":99.99,"mcd":100,"pulse":100,"rate_connect":99.99,"date_live":"2025-01-17T10:30:00Z","status":"Active","lcr_json":"Sample lcr_json text content","cost_lcr":99.99,"intra_lcr":"example_intra_lcr","inter_lcr":"example_inter_lcr","peak_lcr":"example_peak_lcr","evening_lcr":"example_evening_lcr","weekend_lcr":"example_weekend_lcr"},{"id":12345,"rev_id":1,"prefix":"example_prefix","name":"Example Name","cost":99.99,"intra":99.99,"inter":99.99,"peak":99.99,"evening":99.99,"weekend":99.99,"mcd":100,"pulse":100,"rate_connect":99.99,"date_live":"2025-01-17T10:30:00Z","status":"Active","lcr_json":"Sample lcr_json text content","cost_lcr":99.99,"intra_lcr":"example_intra_lcr","inter_lcr":"example_inter_lcr","peak_lcr":"example_peak_lcr","evening_lcr":"example_evening_lcr","weekend_lcr":"example_weekend_lcr"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Rule"],"summary":"Create","description":"Create a new Rule record.","operationId":"ruleCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleInput"},"example":{"rev_id":1,"prefix":"example_prefix","name":"Example Name","cost":99.99,"intra":99.99,"inter":99.99,"peak":99.99,"evening":99.99,"weekend":99.99,"mcd":100,"pulse":100,"rate_connect":99.99,"date_live":"2025-01-17T10:30:00Z","status":"Active","lcr_json":"Sample lcr_json text content","cost_lcr":99.99,"intra_lcr":"example_intra_lcr","inter_lcr":"example_inter_lcr","peak_lcr":"example_peak_lcr","evening_lcr":"example_evening_lcr","weekend_lcr":"example_weekend_lcr"}}}}}},"/api/cp/rule/{id}":{"get":{"tags":["Rule"],"summary":"Read","description":"Retrieve a single Rule record by ID.","operationId":"ruleRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule"},"example":{"id":12345,"rev_id":1,"prefix":"example_prefix","name":"Example Name","cost":99.99,"intra":99.99,"inter":99.99,"peak":99.99,"evening":99.99,"weekend":99.99,"mcd":100,"pulse":100,"rate_connect":99.99,"date_live":"2025-01-17T10:30:00Z","status":"Active","lcr_json":"Sample lcr_json text content","cost_lcr":99.99,"intra_lcr":"example_intra_lcr","inter_lcr":"example_inter_lcr","peak_lcr":"example_peak_lcr","evening_lcr":"example_evening_lcr","weekend_lcr":"example_weekend_lcr"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Rule"],"summary":"Update","description":"Update an existing Rule record by ID.","operationId":"ruleUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleInput"},"example":{"rev_id":1,"prefix":"example_prefix","name":"Example Name","cost":99.99,"intra":99.99,"inter":99.99,"peak":99.99,"evening":99.99,"weekend":99.99,"mcd":100,"pulse":100,"rate_connect":99.99,"date_live":"2025-01-17T10:30:00Z","status":"Active","lcr_json":"Sample lcr_json text content","cost_lcr":99.99,"intra_lcr":"example_intra_lcr","inter_lcr":"example_inter_lcr","peak_lcr":"example_peak_lcr","evening_lcr":"example_evening_lcr","weekend_lcr":"example_weekend_lcr"}}}}},"delete":{"tags":["Rule"],"summary":"Delete","description":"Delete a Rule record by ID.","operationId":"ruleDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/scriptforge":{"get":{"tags":["Script Forge"],"summary":"List","description":"Retrieve a paginated list of Script Forge records. Supports filtering, sorting, and search.","operationId":"scriptForgeList","parameters":[{"in":"query","name":"type","description":"Filter by Type","required":false,"schema":{"type":"string","enum":["legacy","script","app","debug","driver","worker","quickjs"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/scriptForge"}},"example":[{"id":12345,"account_id":1,"app_id":1,"uuid":"example_uuid","name":"Example Name","language":"example_language","code":"Sample code text content","timeout":123,"processes":1,"active":true,"form_id":1,"async":1,"public":1,"type":"legacy","version":"example_version","scriptforge_repo_id":1,"scriptforge_repo_version":"example_scriptforge_repo_version","c5_dest":"example_c5_dest","pbx_server":"example_pbx_server","global_routing_priority":1,"cron":"example_cron","ram":123,"load":1.5,"hosts":"example_hosts"},{"id":12345,"account_id":1,"app_id":1,"uuid":"example_uuid","name":"Example Name","language":"example_language","code":"Sample code text content","timeout":123,"processes":1,"active":true,"form_id":1,"async":1,"public":1,"type":"legacy","version":"example_version","scriptforge_repo_id":1,"scriptforge_repo_version":"example_scriptforge_repo_version","c5_dest":"example_c5_dest","pbx_server":"example_pbx_server","global_routing_priority":1,"cron":"example_cron","ram":123,"load":1.5,"hosts":"example_hosts"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Script Forge"],"summary":"Create","description":"Create a new Script Forge record.","operationId":"scriptForgeCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/scriptForgeInput"},"example":{"account_id":1,"app_id":1,"uuid":"example_uuid","name":"Example Name","language":"example_language","code":"Sample code text content","timeout":123,"processes":1,"active":true,"form_id":1,"async":1,"public":1,"type":"legacy","version":"example_version","scriptforge_repo_id":1,"scriptforge_repo_version":"example_scriptforge_repo_version","c5_dest":"example_c5_dest","pbx_server":"example_pbx_server","global_routing_priority":1,"cron":"example_cron","ram":123,"load":1.5,"hosts":"example_hosts"}}}}}},"/api/cp/scriptforge/cache":{"get":{"tags":["Script Forge"],"summary":"Get Cache Keys","description":"Get Cache Keys","operationId":"scriptForgeGetCacheKeys","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scriptForge"},"example":{"id":12345,"account_id":1,"app_id":1,"uuid":"example_uuid","name":"Example Name","language":"example_language","code":"Sample code text content","timeout":123,"processes":1,"active":true,"form_id":1,"async":1,"public":1,"type":"legacy","version":"example_version","scriptforge_repo_id":1,"scriptforge_repo_version":"example_scriptforge_repo_version","c5_dest":"example_c5_dest","pbx_server":"example_pbx_server","global_routing_priority":1,"cron":"example_cron","ram":123,"load":1.5,"hosts":"example_hosts"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/scriptforge/cache-usage":{"get":{"tags":["Script Forge"],"summary":"Cache Usage","description":"Cache Usage","operationId":"scriptForgeCacheUsage","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scriptForge"},"example":{"id":12345,"account_id":1,"app_id":1,"uuid":"example_uuid","name":"Example Name","language":"example_language","code":"Sample code text content","timeout":123,"processes":1,"active":true,"form_id":1,"async":1,"public":1,"type":"legacy","version":"example_version","scriptforge_repo_id":1,"scriptforge_repo_version":"example_scriptforge_repo_version","c5_dest":"example_c5_dest","pbx_server":"example_pbx_server","global_routing_priority":1,"cron":"example_cron","ram":123,"load":1.5,"hosts":"example_hosts"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/scriptforge/cache/{id}":{"get":{"tags":["Script Forge"],"summary":"Get Cache Value","description":"Get Cache Value","operationId":"scriptForgeGetCacheValue","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scriptForge"},"example":{"id":12345,"account_id":1,"app_id":1,"uuid":"example_uuid","name":"Example Name","language":"example_language","code":"Sample code text content","timeout":123,"processes":1,"active":true,"form_id":1,"async":1,"public":1,"type":"legacy","version":"example_version","scriptforge_repo_id":1,"scriptforge_repo_version":"example_scriptforge_repo_version","c5_dest":"example_c5_dest","pbx_server":"example_pbx_server","global_routing_priority":1,"cron":"example_cron","ram":123,"load":1.5,"hosts":"example_hosts"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/scriptforge/examples":{"get":{"tags":["Script Forge"],"summary":"Examples","description":"Examples","operationId":"scriptForgeExamples","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scriptForge"},"example":{"id":12345,"account_id":1,"app_id":1,"uuid":"example_uuid","name":"Example Name","language":"example_language","code":"Sample code text content","timeout":123,"processes":1,"active":true,"form_id":1,"async":1,"public":1,"type":"legacy","version":"example_version","scriptforge_repo_id":1,"scriptforge_repo_version":"example_scriptforge_repo_version","c5_dest":"example_c5_dest","pbx_server":"example_pbx_server","global_routing_priority":1,"cron":"example_cron","ram":123,"load":1.5,"hosts":"example_hosts"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/scriptforge/{appId}/{id}/{fn}":{"post":{"tags":["Script Forge"],"summary":"Run (In Project Context)","description":"Run (In Project Context)","operationId":"scriptForgeRunInProjectContext","parameters":[{"in":"path","name":"appId","description":"App Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345},{"in":"path","name":"fn","description":"Fn identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/scriptForgeInput"},"example":{"account_id":1,"app_id":1,"uuid":"example_uuid","name":"Example Name","language":"example_language","code":"Sample code text content","timeout":123,"processes":1,"active":true,"form_id":1,"async":1,"public":1,"type":"legacy","version":"example_version","scriptforge_repo_id":1,"scriptforge_repo_version":"example_scriptforge_repo_version","c5_dest":"example_c5_dest","pbx_server":"example_pbx_server","global_routing_priority":1,"cron":"example_cron","ram":123,"load":1.5,"hosts":"example_hosts"}}}}}},"/api/cp/scriptforge/{id.doc.html}":{"get":{"tags":["Script Forge"],"summary":"ScriptForge JsDoc Documentation","description":"ScriptForge JsDoc Documentation","operationId":"scriptForgeScriptForgeJsDocDocumentation","parameters":[{"in":"path","name":"id.doc.html","description":"Id Doc Html identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scriptForge"},"example":{"id":12345,"account_id":1,"app_id":1,"uuid":"example_uuid","name":"Example Name","language":"example_language","code":"Sample code text content","timeout":123,"processes":1,"active":true,"form_id":1,"async":1,"public":1,"type":"legacy","version":"example_version","scriptforge_repo_id":1,"scriptforge_repo_version":"example_scriptforge_repo_version","c5_dest":"example_c5_dest","pbx_server":"example_pbx_server","global_routing_priority":1,"cron":"example_cron","ram":123,"load":1.5,"hosts":"example_hosts"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/scriptforge/{id}":{"get":{"tags":["Script Forge"],"summary":"Read","description":"Retrieve a single Script Forge record by ID.","operationId":"scriptForgeRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scriptForge"},"example":{"id":12345,"account_id":1,"app_id":1,"uuid":"example_uuid","name":"Example Name","language":"example_language","code":"Sample code text content","timeout":123,"processes":1,"active":true,"form_id":1,"async":1,"public":1,"type":"legacy","version":"example_version","scriptforge_repo_id":1,"scriptforge_repo_version":"example_scriptforge_repo_version","c5_dest":"example_c5_dest","pbx_server":"example_pbx_server","global_routing_priority":1,"cron":"example_cron","ram":123,"load":1.5,"hosts":"example_hosts"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Script Forge"],"summary":"Update","description":"Update an existing Script Forge record by ID.","operationId":"scriptForgeUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/scriptForgeInput"},"example":{"account_id":1,"app_id":1,"uuid":"example_uuid","name":"Example Name","language":"example_language","code":"Sample code text content","timeout":123,"processes":1,"active":true,"form_id":1,"async":1,"public":1,"type":"legacy","version":"example_version","scriptforge_repo_id":1,"scriptforge_repo_version":"example_scriptforge_repo_version","c5_dest":"example_c5_dest","pbx_server":"example_pbx_server","global_routing_priority":1,"cron":"example_cron","ram":123,"load":1.5,"hosts":"example_hosts"}}}}},"delete":{"tags":["Script Forge"],"summary":"Delete","description":"Delete a Script Forge record by ID.","operationId":"scriptForgeDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/scriptforge/{id}/job":{"post":{"tags":["Script Forge"],"summary":"Job","description":"Job","operationId":"scriptForgeJob","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/scriptForgeInput"},"example":{"account_id":1,"app_id":1,"uuid":"example_uuid","name":"Example Name","language":"example_language","code":"Sample code text content","timeout":123,"processes":1,"active":true,"form_id":1,"async":1,"public":1,"type":"legacy","version":"example_version","scriptforge_repo_id":1,"scriptforge_repo_version":"example_scriptforge_repo_version","c5_dest":"example_c5_dest","pbx_server":"example_pbx_server","global_routing_priority":1,"cron":"example_cron","ram":123,"load":1.5,"hosts":"example_hosts"}}}}}},"/api/cp/scriptforge/{id}/log":{"get":{"tags":["Script Forge"],"summary":"Log","description":"Log","operationId":"scriptForgeLog","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scriptForge"},"example":{"id":12345,"account_id":1,"app_id":1,"uuid":"example_uuid","name":"Example Name","language":"example_language","code":"Sample code text content","timeout":123,"processes":1,"active":true,"form_id":1,"async":1,"public":1,"type":"legacy","version":"example_version","scriptforge_repo_id":1,"scriptforge_repo_version":"example_scriptforge_repo_version","c5_dest":"example_c5_dest","pbx_server":"example_pbx_server","global_routing_priority":1,"cron":"example_cron","ram":123,"load":1.5,"hosts":"example_hosts"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"socket":{"tags":["Script Forge"],"summary":"Log Socket","description":"Log Socket","operationId":"scriptForgeLogSocket","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/scriptforge/{id}/log/sse":{"get":{"tags":["Script Forge"],"summary":"Log SSE","description":"Log SSE","operationId":"scriptForgeLogSse","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scriptForge"},"example":{"id":12345,"account_id":1,"app_id":1,"uuid":"example_uuid","name":"Example Name","language":"example_language","code":"Sample code text content","timeout":123,"processes":1,"active":true,"form_id":1,"async":1,"public":1,"type":"legacy","version":"example_version","scriptforge_repo_id":1,"scriptforge_repo_version":"example_scriptforge_repo_version","c5_dest":"example_c5_dest","pbx_server":"example_pbx_server","global_routing_priority":1,"cron":"example_cron","ram":123,"load":1.5,"hosts":"example_hosts"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/scriptforge/{id}/run/{fn}":{"post":{"tags":["Script Forge"],"summary":"Run","description":"Run","operationId":"scriptForgeRun","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345},{"in":"path","name":"fn","description":"Fn identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/scriptForgeInput"},"example":{"account_id":1,"app_id":1,"uuid":"example_uuid","name":"Example Name","language":"example_language","code":"Sample code text content","timeout":123,"processes":1,"active":true,"form_id":1,"async":1,"public":1,"type":"legacy","version":"example_version","scriptforge_repo_id":1,"scriptforge_repo_version":"example_scriptforge_repo_version","c5_dest":"example_c5_dest","pbx_server":"example_pbx_server","global_routing_priority":1,"cron":"example_cron","ram":123,"load":1.5,"hosts":"example_hosts"}}}}}},"/api/cp/scriptforge/{id}/{fn}":{"socket":{"tags":["Script Forge"],"summary":"ScriptForge Socket","description":"ScriptForge Socket","operationId":"scriptForgeScriptForgeSocket","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345},{"in":"path","name":"fn","description":"Fn identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/account":{"put":{"tags":["Setup Account"],"summary":"Update","description":"Update an existing Setup Account record by ID.","operationId":"setupAccountUpdate","parameters":[],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"get":{"tags":["Setup Account"],"summary":"Account Detail","description":"Account Detail","operationId":"setupAccountAccountDetail","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/account-manager-comission":{"get":{"tags":["Setup Account Manager Comission"],"summary":"List","description":"Retrieve a paginated list of Setup Account Manager Comission records. Supports filtering, sorting, and search.","operationId":"setupAccountManagerComissionList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupAccountManagerComission"}},"example":[{"id":12345,"user_id":1,"start_date":"2025-01-17T10:30:00Z","end_date":"2025-01-17T10:30:00Z","comission":99.99},{"id":12345,"user_id":1,"start_date":"2025-01-17T10:30:00Z","end_date":"2025-01-17T10:30:00Z","comission":99.99}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Account Manager Comission"],"summary":"Create","description":"Create a new Setup Account Manager Comission record.","operationId":"setupAccountManagerComissionCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupAccountManagerComissionInput"},"example":{"user_id":1,"start_date":"2025-01-17T10:30:00Z","end_date":"2025-01-17T10:30:00Z","comission":99.99}}}}}},"/api/cp/setup/account-manager-comission/{id}":{"get":{"tags":["Setup Account Manager Comission"],"summary":"Read","description":"Retrieve a single Setup Account Manager Comission record by ID.","operationId":"setupAccountManagerComissionRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupAccountManagerComission"},"example":{"id":12345,"user_id":1,"start_date":"2025-01-17T10:30:00Z","end_date":"2025-01-17T10:30:00Z","comission":99.99}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Account Manager Comission"],"summary":"Update","description":"Update an existing Setup Account Manager Comission record by ID.","operationId":"setupAccountManagerComissionUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupAccountManagerComissionInput"},"example":{"user_id":1,"start_date":"2025-01-17T10:30:00Z","end_date":"2025-01-17T10:30:00Z","comission":99.99}}}}},"delete":{"tags":["Setup Account Manager Comission"],"summary":"Delete","description":"Delete a Setup Account Manager Comission record by ID.","operationId":"setupAccountManagerComissionDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/account-manager-payment":{"get":{"tags":["Setup Account Manager Comission"],"summary":"List","description":"Retrieve a paginated list of Setup Account Manager Comission records. Supports filtering, sorting, and search.","operationId":"setupAccountManagerComissionList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupAccountManagerComission"}},"example":[{"id":12345,"created_at":"2025-01-17T10:30:00Z","user_id":1,"amount":99.99,"currency":"USD","description":"A detailed description of the resource"},{"id":12345,"created_at":"2025-01-17T10:30:00Z","user_id":1,"amount":99.99,"currency":"USD","description":"A detailed description of the resource"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Account Manager Comission"],"summary":"Create","description":"Create a new Setup Account Manager Comission record.","operationId":"setupAccountManagerComissionCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupAccountManagerComissionInput"},"example":{"user_id":1,"amount":99.99,"currency":"USD","description":"A detailed description of the resource"}}}}}},"/api/cp/setup/account-manager-payment/{id}":{"get":{"tags":["Setup Account Manager Comission"],"summary":"Read","description":"Retrieve a single Setup Account Manager Comission record by ID.","operationId":"setupAccountManagerComissionRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupAccountManagerComission"},"example":{"id":12345,"created_at":"2025-01-17T10:30:00Z","user_id":1,"amount":99.99,"currency":"USD","description":"A detailed description of the resource"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Account Manager Comission"],"summary":"Update","description":"Update an existing Setup Account Manager Comission record by ID.","operationId":"setupAccountManagerComissionUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupAccountManagerComissionInput"},"example":{"user_id":1,"amount":99.99,"currency":"USD","description":"A detailed description of the resource"}}}}},"delete":{"tags":["Setup Account Manager Comission"],"summary":"Delete","description":"Delete a Setup Account Manager Comission record by ID.","operationId":"setupAccountManagerComissionDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/account/config":{"get":{"tags":["Setup Account"],"summary":"Read Config","description":"Read Config","operationId":"setupAccountReadConfig","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/account/config/{key}":{"put":{"tags":["Setup Account"],"summary":"Write Config","description":"Write Config","operationId":"setupAccountWriteConfig","parameters":[{"in":"path","name":"key","description":"Key identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/account/test-email":{"get":{"tags":["Setup Account"],"summary":"Test Email","description":"Test Email","operationId":"setupAccountTestEmail","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/account/test-sms":{"get":{"tags":["Setup Account"],"summary":"Test SMS","description":"Test SMS","operationId":"setupAccountTestSms","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/anycast-loadbalancer":{"get":{"tags":["Anycast Loadbalancer"],"summary":"List","description":"Retrieve a paginated list of Anycast Loadbalancer records. Supports filtering, sorting, and search.","operationId":"anycastLoadbalancerList","parameters":[{"in":"query","name":"insertion","description":"Filter by Insertion","required":false,"schema":{"type":"string","enum":["stateless","transactional","dialog"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/anycastLoadbalancer"}},"example":[{"id":12345,"account_id":1,"ip":"192.168.1.1","cost":99.99,"uac_test":"example_uac_test","alg":1,"cps":123,"created_on":"2025-01-17T10:30:00Z","internal_only":1,"validate":"example_validate","compress_in":"example_compress_in","compress_out":"example_compress_out","insertion":"stateless","flags":"example_flags","primary_attempts":1,"secondary_attempts":1},{"id":12345,"account_id":1,"ip":"192.168.1.1","cost":99.99,"uac_test":"example_uac_test","alg":1,"cps":123,"created_on":"2025-01-17T10:30:00Z","internal_only":1,"validate":"example_validate","compress_in":"example_compress_in","compress_out":"example_compress_out","insertion":"stateless","flags":"example_flags","primary_attempts":1,"secondary_attempts":1}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Anycast Loadbalancer"],"summary":"Create","description":"Create a new Anycast Loadbalancer record.","operationId":"anycastLoadbalancerCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/anycastLoadbalancerInput"},"example":{"account_id":1,"ip":"192.168.1.1","cost":99.99,"uac_test":"example_uac_test","alg":1,"cps":123,"created_on":"2025-01-17T10:30:00Z","internal_only":1,"validate":"example_validate","compress_in":"example_compress_in","compress_out":"example_compress_out","insertion":"stateless","flags":"example_flags","primary_attempts":1,"secondary_attempts":1}}}}}},"/api/cp/setup/anycast-loadbalancer-destination":{"get":{"tags":["Anycast Loadbalancer Destination"],"summary":"List","description":"Retrieve a paginated list of Anycast Loadbalancer Destination records. Supports filtering, sorting, and search.","operationId":"anycastLoadbalancerDestinationList","parameters":[{"in":"query","name":"proto","description":"Filter by Proto","required":false,"schema":{"type":"string","enum":["default","udp","tcp"]}},{"in":"query","name":"state","description":"Filter by State","required":false,"schema":{"type":"string","enum":["Active","Inactive","Probing"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/anycastLoadbalancerDestination"}},"example":[{"id":12345,"anycast_dispatcher_id":1,"destination":"example_destination","proto":"default","weight":1,"priority":1,"state":"Active","zone":"example_zone","backup_zone":"example_backup_zone"},{"id":12345,"anycast_dispatcher_id":1,"destination":"example_destination","proto":"default","weight":1,"priority":1,"state":"Active","zone":"example_zone","backup_zone":"example_backup_zone"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Anycast Loadbalancer Destination"],"summary":"Create","description":"Create a new Anycast Loadbalancer Destination record.","operationId":"anycastLoadbalancerDestinationCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/anycastLoadbalancerDestinationInput"},"example":{"anycast_dispatcher_id":1,"destination":"example_destination","proto":"default","weight":1,"priority":1,"state":"Active","zone":"example_zone","backup_zone":"example_backup_zone"}}}}}},"/api/cp/setup/anycast-loadbalancer-destination/{id}":{"get":{"tags":["Anycast Loadbalancer Destination"],"summary":"Read","description":"Retrieve a single Anycast Loadbalancer Destination record by ID.","operationId":"anycastLoadbalancerDestinationRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/anycastLoadbalancerDestination"},"example":{"id":12345,"anycast_dispatcher_id":1,"destination":"example_destination","proto":"default","weight":1,"priority":1,"state":"Active","zone":"example_zone","backup_zone":"example_backup_zone"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Anycast Loadbalancer Destination"],"summary":"Update","description":"Update an existing Anycast Loadbalancer Destination record by ID.","operationId":"anycastLoadbalancerDestinationUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/anycastLoadbalancerDestinationInput"},"example":{"anycast_dispatcher_id":1,"destination":"example_destination","proto":"default","weight":1,"priority":1,"state":"Active","zone":"example_zone","backup_zone":"example_backup_zone"}}}}},"delete":{"tags":["Anycast Loadbalancer Destination"],"summary":"Delete","description":"Delete a Anycast Loadbalancer Destination record by ID.","operationId":"anycastLoadbalancerDestinationDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/anycast-loadbalancer/{id}":{"get":{"tags":["Anycast Loadbalancer"],"summary":"Read","description":"Retrieve a single Anycast Loadbalancer record by ID.","operationId":"anycastLoadbalancerRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/anycastLoadbalancer"},"example":{"id":12345,"account_id":1,"ip":"192.168.1.1","cost":99.99,"uac_test":"example_uac_test","alg":1,"cps":123,"created_on":"2025-01-17T10:30:00Z","internal_only":1,"validate":"example_validate","compress_in":"example_compress_in","compress_out":"example_compress_out","insertion":"stateless","flags":"example_flags","primary_attempts":1,"secondary_attempts":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Anycast Loadbalancer"],"summary":"Update","description":"Update an existing Anycast Loadbalancer record by ID.","operationId":"anycastLoadbalancerUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/anycastLoadbalancerInput"},"example":{"account_id":1,"ip":"192.168.1.1","cost":99.99,"uac_test":"example_uac_test","alg":1,"cps":123,"created_on":"2025-01-17T10:30:00Z","internal_only":1,"validate":"example_validate","compress_in":"example_compress_in","compress_out":"example_compress_out","insertion":"stateless","flags":"example_flags","primary_attempts":1,"secondary_attempts":1}}}}},"delete":{"tags":["Anycast Loadbalancer"],"summary":"Delete","description":"Delete a Anycast Loadbalancer record by ID.","operationId":"anycastLoadbalancerDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/anyedge-domain":{"get":{"tags":["Any Edge Domain"],"summary":"List","description":"Retrieve a paginated list of Any Edge Domain records. Supports filtering, sorting, and search.","operationId":"anyEdgeDomainList","parameters":[{"in":"query","name":"status","description":"Filter by Status","required":false,"schema":{"type":"string","enum":["Pending","Ready","Error"]}},{"in":"query","name":"method","description":"Filter by Method","required":false,"schema":{"type":"string","enum":["SSLv23","SSLv3","TLSv1","TLSv1_2","none"]}},{"in":"query","name":"insertion","description":"Filter by Insertion","required":false,"schema":{"type":"string","enum":["stateless","transactional","dialog"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/anyEdgeDomain"}},"example":[{"id":12345,"anycast_dispatcher_id":1,"domain":"example_domain","status":"Pending","method":"SSLv23","verify_cert":1,"require_cert":1,"cipher_list":"example_cipher_list","ec_curve":"example_ec_curve","uac_test":"example_uac_test","alg":1,"cps":123,"validate":"example_validate","compress_in":"example_compress_in","compress_out":"example_compress_out","insertion":"stateless","flags":"example_flags","last_updated":"2025-01-17T10:30:00Z","primary_attempts":1,"secondary_attempts":1},{"id":12345,"anycast_dispatcher_id":1,"domain":"example_domain","status":"Pending","method":"SSLv23","verify_cert":1,"require_cert":1,"cipher_list":"example_cipher_list","ec_curve":"example_ec_curve","uac_test":"example_uac_test","alg":1,"cps":123,"validate":"example_validate","compress_in":"example_compress_in","compress_out":"example_compress_out","insertion":"stateless","flags":"example_flags","last_updated":"2025-01-17T10:30:00Z","primary_attempts":1,"secondary_attempts":1}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Any Edge Domain"],"summary":"Create","description":"Create a new Any Edge Domain record.","operationId":"anyEdgeDomainCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/anyEdgeDomainInput"},"example":{"anycast_dispatcher_id":1,"domain":"example_domain","status":"Pending","method":"SSLv23","verify_cert":1,"require_cert":1,"cipher_list":"example_cipher_list","ec_curve":"example_ec_curve","uac_test":"example_uac_test","alg":1,"cps":123,"validate":"example_validate","compress_in":"example_compress_in","compress_out":"example_compress_out","insertion":"stateless","flags":"example_flags","last_updated":"2025-01-17T10:30:00Z","primary_attempts":1,"secondary_attempts":1}}}}}},"/api/cp/setup/anyedge-domain/ciphers":{"get":{"tags":["Any Edge Domain"],"summary":"Ciphers","description":"Ciphers","operationId":"anyEdgeDomainCiphers","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/anyEdgeDomain"},"example":{"id":12345,"anycast_dispatcher_id":1,"domain":"example_domain","status":"Pending","method":"SSLv23","verify_cert":1,"require_cert":1,"cipher_list":"example_cipher_list","ec_curve":"example_ec_curve","uac_test":"example_uac_test","alg":1,"cps":123,"validate":"example_validate","compress_in":"example_compress_in","compress_out":"example_compress_out","insertion":"stateless","flags":"example_flags","last_updated":"2025-01-17T10:30:00Z","primary_attempts":1,"secondary_attempts":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/anyedge-domain/curves":{"get":{"tags":["Any Edge Domain"],"summary":"Curves","description":"Curves","operationId":"anyEdgeDomainCurves","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/anyEdgeDomain"},"example":{"id":12345,"anycast_dispatcher_id":1,"domain":"example_domain","status":"Pending","method":"SSLv23","verify_cert":1,"require_cert":1,"cipher_list":"example_cipher_list","ec_curve":"example_ec_curve","uac_test":"example_uac_test","alg":1,"cps":123,"validate":"example_validate","compress_in":"example_compress_in","compress_out":"example_compress_out","insertion":"stateless","flags":"example_flags","last_updated":"2025-01-17T10:30:00Z","primary_attempts":1,"secondary_attempts":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/anyedge-domain/{id}":{"get":{"tags":["Any Edge Domain"],"summary":"Read","description":"Retrieve a single Any Edge Domain record by ID.","operationId":"anyEdgeDomainRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/anyEdgeDomain"},"example":{"id":12345,"anycast_dispatcher_id":1,"domain":"example_domain","status":"Pending","method":"SSLv23","verify_cert":1,"require_cert":1,"cipher_list":"example_cipher_list","ec_curve":"example_ec_curve","uac_test":"example_uac_test","alg":1,"cps":123,"validate":"example_validate","compress_in":"example_compress_in","compress_out":"example_compress_out","insertion":"stateless","flags":"example_flags","last_updated":"2025-01-17T10:30:00Z","primary_attempts":1,"secondary_attempts":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Any Edge Domain"],"summary":"Update","description":"Update an existing Any Edge Domain record by ID.","operationId":"anyEdgeDomainUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/anyEdgeDomainInput"},"example":{"anycast_dispatcher_id":1,"domain":"example_domain","status":"Pending","method":"SSLv23","verify_cert":1,"require_cert":1,"cipher_list":"example_cipher_list","ec_curve":"example_ec_curve","uac_test":"example_uac_test","alg":1,"cps":123,"validate":"example_validate","compress_in":"example_compress_in","compress_out":"example_compress_out","insertion":"stateless","flags":"example_flags","last_updated":"2025-01-17T10:30:00Z","primary_attempts":1,"secondary_attempts":1}}}}},"delete":{"tags":["Any Edge Domain"],"summary":"Delete","description":"Delete a Any Edge Domain record by ID.","operationId":"anyEdgeDomainDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/api":{"get":{"tags":["Setup API"],"summary":"List","description":"Retrieve a paginated list of Setup API records. Supports filtering, sorting, and search.","operationId":"setupApiList","parameters":[{"in":"query","name":"type","description":"Filter by Type","required":false,"schema":{"type":"string"}},{"in":"query","name":"mode","description":"Filter by Mode","required":false,"schema":{"type":"string","enum":["sandbox","live","dev","test"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupApi"}},"example":[{"id":12345,"account_id":1,"type":"example_type","mode":"sandbox","email":"user@example.com","host":"example_host","username":"john_doe","password":"********","signature":"Sample signature text content","api_id":1,"public_key":"example_public_key","private_key":"example_private_key","key1":"example_key1","key2":"example_key2","key3":"example_key3","key4":"example_key4","currency":"USD","verify_transaction":1,"payment_types":"example_payment_types","company_id":1,"sandbox_id":1,"deduct_payment_fees":1,"surcharge":99.99,"surcharge_percent":1.5},{"id":12345,"account_id":1,"type":"example_type","mode":"sandbox","email":"user@example.com","host":"example_host","username":"john_doe","password":"********","signature":"Sample signature text content","api_id":1,"public_key":"example_public_key","private_key":"example_private_key","key1":"example_key1","key2":"example_key2","key3":"example_key3","key4":"example_key4","currency":"USD","verify_transaction":1,"payment_types":"example_payment_types","company_id":1,"sandbox_id":1,"deduct_payment_fees":1,"surcharge":99.99,"surcharge_percent":1.5}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup API"],"summary":"Create","description":"Create a new Setup API record.","operationId":"setupApiCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupApiInput"},"example":{"account_id":1,"type":"example_type","mode":"sandbox","email":"user@example.com","host":"example_host","username":"john_doe","password":"********","signature":"Sample signature text content","api_id":1,"public_key":"example_public_key","private_key":"example_private_key","key1":"example_key1","key2":"example_key2","key3":"example_key3","key4":"example_key4","currency":"USD","verify_transaction":1,"payment_types":"example_payment_types","company_id":1,"sandbox_id":1,"deduct_payment_fees":1,"surcharge":99.99,"surcharge_percent":1.5}}}}}},"/api/cp/setup/api/xero":{"get":{"tags":["Setup API"],"summary":"Check","description":"Check","operationId":"setupApiCheck","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupApi"},"example":{"id":12345,"account_id":1,"type":"example_type","mode":"sandbox","email":"user@example.com","host":"example_host","username":"john_doe","password":"********","signature":"Sample signature text content","api_id":1,"public_key":"example_public_key","private_key":"example_private_key","key1":"example_key1","key2":"example_key2","key3":"example_key3","key4":"example_key4","currency":"USD","verify_transaction":1,"payment_types":"example_payment_types","company_id":1,"sandbox_id":1,"deduct_payment_fees":1,"surcharge":99.99,"surcharge_percent":1.5}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/api/{id}":{"get":{"tags":["Setup API"],"summary":"Read","description":"Retrieve a single Setup API record by ID.","operationId":"setupApiRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupApi"},"example":{"id":12345,"account_id":1,"type":"example_type","mode":"sandbox","email":"user@example.com","host":"example_host","username":"john_doe","password":"********","signature":"Sample signature text content","api_id":1,"public_key":"example_public_key","private_key":"example_private_key","key1":"example_key1","key2":"example_key2","key3":"example_key3","key4":"example_key4","currency":"USD","verify_transaction":1,"payment_types":"example_payment_types","company_id":1,"sandbox_id":1,"deduct_payment_fees":1,"surcharge":99.99,"surcharge_percent":1.5}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup API"],"summary":"Update","description":"Update an existing Setup API record by ID.","operationId":"setupApiUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupApiInput"},"example":{"account_id":1,"type":"example_type","mode":"sandbox","email":"user@example.com","host":"example_host","username":"john_doe","password":"********","signature":"Sample signature text content","api_id":1,"public_key":"example_public_key","private_key":"example_private_key","key1":"example_key1","key2":"example_key2","key3":"example_key3","key4":"example_key4","currency":"USD","verify_transaction":1,"payment_types":"example_payment_types","company_id":1,"sandbox_id":1,"deduct_payment_fees":1,"surcharge":99.99,"surcharge_percent":1.5}}}}},"delete":{"tags":["Setup API"],"summary":"Delete","description":"Delete a Setup API record by ID.","operationId":"setupApiDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/app":{"get":{"tags":["Setup App"],"summary":"List","description":"Retrieve a paginated list of Setup App records. Supports filtering, sorting, and search.","operationId":"setupAppList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupApp"}},"example":[{"id":12345,"account_id":1,"repo_id":1,"name":"Example Name","version":"example_version","domain":"example_domain","company_id":1,"framework_version":"example_framework_version","icon":"example_icon","anvil_mcp_api_key":"example_anvil_mcp_api_key"},{"id":12345,"account_id":1,"repo_id":1,"name":"Example Name","version":"example_version","domain":"example_domain","company_id":1,"framework_version":"example_framework_version","icon":"example_icon","anvil_mcp_api_key":"example_anvil_mcp_api_key"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup App"],"summary":"Create","description":"Create a new Setup App record.","operationId":"setupAppCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupAppInput"},"example":{"account_id":1,"repo_id":1,"name":"Example Name","version":"example_version","domain":"example_domain","company_id":1,"framework_version":"example_framework_version","icon":"example_icon","anvil_mcp_api_key":"example_anvil_mcp_api_key"}}}}}},"/api/cp/setup/app/publish/{id}":{"post":{"tags":["Setup App"],"summary":"Publish","description":"Publish","operationId":"setupAppPublish","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupAppInput"},"example":{"account_id":1,"repo_id":1,"name":"Example Name","version":"example_version","domain":"example_domain","company_id":1,"framework_version":"example_framework_version","icon":"example_icon","anvil_mcp_api_key":"example_anvil_mcp_api_key"}}}}}},"/api/cp/setup/app/{id}":{"get":{"tags":["Setup App"],"summary":"Read","description":"Retrieve a single Setup App record by ID.","operationId":"setupAppRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupApp"},"example":{"id":12345,"account_id":1,"repo_id":1,"name":"Example Name","version":"example_version","domain":"example_domain","company_id":1,"framework_version":"example_framework_version","icon":"example_icon","anvil_mcp_api_key":"example_anvil_mcp_api_key"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup App"],"summary":"Update","description":"Update an existing Setup App record by ID.","operationId":"setupAppUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupAppInput"},"example":{"account_id":1,"repo_id":1,"name":"Example Name","version":"example_version","domain":"example_domain","company_id":1,"framework_version":"example_framework_version","icon":"example_icon","anvil_mcp_api_key":"example_anvil_mcp_api_key"}}}}},"delete":{"tags":["Setup App"],"summary":"Delete","description":"Delete a Setup App record by ID.","operationId":"setupAppDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/audit":{"get":{"tags":["Setup Audit"],"summary":"List","description":"Retrieve a paginated list of Setup Audit records. Supports filtering, sorting, and search.","operationId":"setupAuditList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupAudit"}},"example":[{"id":12345,"account_id":1,"user_id":1,"contact_id":1,"ip":"192.168.1.1","dt":"2025-01-17T10:30:00Z","pk":"example_pk","action":"example_action","table":"example_table","msg":"example_msg","data":"Sample data text content"},{"id":12345,"account_id":1,"user_id":1,"contact_id":1,"ip":"192.168.1.1","dt":"2025-01-17T10:30:00Z","pk":"example_pk","action":"example_action","table":"example_table","msg":"example_msg","data":"Sample data text content"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/audit/{param(ip|action|table)}":{"get":{"tags":["Setup Audit"],"summary":"Groups","description":"Groups","operationId":"setupAuditGroups","parameters":[{"in":"path","name":"param(ip|action|table)","description":"Param Ip Action Table identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupAudit"},"example":{"id":12345,"account_id":1,"user_id":1,"contact_id":1,"ip":"192.168.1.1","dt":"2025-01-17T10:30:00Z","pk":"example_pk","action":"example_action","table":"example_table","msg":"example_msg","data":"Sample data text content"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/button":{"get":{"tags":["Setup Button"],"summary":"List","description":"Retrieve a paginated list of Setup Button records. Supports filtering, sorting, and search.","operationId":"setupButtonList","parameters":[{"in":"query","name":"type","description":"Filter by Type","required":false,"schema":{"type":"string"}},{"in":"query","name":"open_mode","description":"Filter by Open Mode","required":false,"schema":{"type":"string","enum":["page","dialog"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupButton"}},"example":[{"id":12345,"account_id":1,"company_id":1,"app_id":1,"anvil_path":"example_anvil_path","label":"example_label","icon":"example_icon","tooltip":"example_tooltip","type":"example_type","area":"example_area","placement":"example_placement","min_select":123,"max_select":123,"sandbox_id":1,"fn":"example_fn","form_id":1,"page_id":1,"sort_order":1,"company_ids":"example_company_ids","open_mode":"page"},{"id":12345,"account_id":1,"company_id":1,"app_id":1,"anvil_path":"example_anvil_path","label":"example_label","icon":"example_icon","tooltip":"example_tooltip","type":"example_type","area":"example_area","placement":"example_placement","min_select":123,"max_select":123,"sandbox_id":1,"fn":"example_fn","form_id":1,"page_id":1,"sort_order":1,"company_ids":"example_company_ids","open_mode":"page"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Button"],"summary":"Create","description":"Create a new Setup Button record.","operationId":"setupButtonCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupButtonInput"},"example":{"account_id":1,"company_id":1,"app_id":1,"anvil_path":"example_anvil_path","label":"example_label","icon":"example_icon","tooltip":"example_tooltip","type":"example_type","area":"example_area","placement":"example_placement","min_select":123,"max_select":123,"sandbox_id":1,"fn":"example_fn","form_id":1,"page_id":1,"sort_order":1,"company_ids":"example_company_ids","open_mode":"page"}}}}}},"/api/cp/setup/button/{id}":{"get":{"tags":["Setup Button"],"summary":"Read","description":"Retrieve a single Setup Button record by ID.","operationId":"setupButtonRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupButton"},"example":{"id":12345,"account_id":1,"company_id":1,"app_id":1,"anvil_path":"example_anvil_path","label":"example_label","icon":"example_icon","tooltip":"example_tooltip","type":"example_type","area":"example_area","placement":"example_placement","min_select":123,"max_select":123,"sandbox_id":1,"fn":"example_fn","form_id":1,"page_id":1,"sort_order":1,"company_ids":"example_company_ids","open_mode":"page"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Button"],"summary":"Update","description":"Update an existing Setup Button record by ID.","operationId":"setupButtonUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupButtonInput"},"example":{"account_id":1,"company_id":1,"app_id":1,"anvil_path":"example_anvil_path","label":"example_label","icon":"example_icon","tooltip":"example_tooltip","type":"example_type","area":"example_area","placement":"example_placement","min_select":123,"max_select":123,"sandbox_id":1,"fn":"example_fn","form_id":1,"page_id":1,"sort_order":1,"company_ids":"example_company_ids","open_mode":"page"}}}}},"delete":{"tags":["Setup Button"],"summary":"Delete","description":"Delete a Setup Button record by ID.","operationId":"setupButtonDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/call-recording/{status}":{"post":{"tags":["Setup Call Recording"],"summary":"Update","description":"Update an existing Setup Call Recording record by ID.","operationId":"setupCallRecordingUpdate","parameters":[{"in":"path","name":"status","description":"Status identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/cert":{"get":{"tags":["Setup Cert"],"summary":"List","description":"Retrieve a paginated list of Setup Cert records. Supports filtering, sorting, and search.","operationId":"setupCertList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupCert"}},"example":[{"id":12345,"account_id":1,"domain":"example_domain","cert":"Sample cert text content","key":"Sample key text content","ca_cert":"Sample ca_cert text content","deployed":1,"user_provided":1,"name":"Example Name","valid_from":"2025-01-17T10:30:00Z","valid_to":"2025-01-17T10:30:00Z","subject_cn":"example_subject_cn"},{"id":12345,"account_id":1,"domain":"example_domain","cert":"Sample cert text content","key":"Sample key text content","ca_cert":"Sample ca_cert text content","deployed":1,"user_provided":1,"name":"Example Name","valid_from":"2025-01-17T10:30:00Z","valid_to":"2025-01-17T10:30:00Z","subject_cn":"example_subject_cn"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Cert"],"summary":"Create","description":"Create a new Setup Cert record.","operationId":"setupCertCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupCertInput"},"example":{"account_id":1,"domain":"example_domain","cert":"Sample cert text content","key":"Sample key text content","ca_cert":"Sample ca_cert text content","deployed":1,"user_provided":1,"name":"Example Name","valid_from":"2025-01-17T10:30:00Z","valid_to":"2025-01-17T10:30:00Z","subject_cn":"example_subject_cn"}}}}}},"/api/cp/setup/cert/deploy":{"post":{"tags":["Setup Cert"],"summary":"Deploy","description":"Deploy","operationId":"setupCertDeploy","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupCertInput"},"example":{"account_id":1,"domain":"example_domain","cert":"Sample cert text content","key":"Sample key text content","ca_cert":"Sample ca_cert text content","deployed":1,"user_provided":1,"name":"Example Name","valid_from":"2025-01-17T10:30:00Z","valid_to":"2025-01-17T10:30:00Z","subject_cn":"example_subject_cn"}}}}}},"/api/cp/setup/cert/{id}":{"get":{"tags":["Setup Cert"],"summary":"Read","description":"Retrieve a single Setup Cert record by ID.","operationId":"setupCertRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupCert"},"example":{"id":12345,"account_id":1,"domain":"example_domain","cert":"Sample cert text content","key":"Sample key text content","ca_cert":"Sample ca_cert text content","deployed":1,"user_provided":1,"name":"Example Name","valid_from":"2025-01-17T10:30:00Z","valid_to":"2025-01-17T10:30:00Z","subject_cn":"example_subject_cn"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Cert"],"summary":"Update","description":"Update an existing Setup Cert record by ID.","operationId":"setupCertUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupCertInput"},"example":{"account_id":1,"domain":"example_domain","cert":"Sample cert text content","key":"Sample key text content","ca_cert":"Sample ca_cert text content","deployed":1,"user_provided":1,"name":"Example Name","valid_from":"2025-01-17T10:30:00Z","valid_to":"2025-01-17T10:30:00Z","subject_cn":"example_subject_cn"}}}}},"delete":{"tags":["Setup Cert"],"summary":"Delete","description":"Delete a Setup Cert record by ID.","operationId":"setupCertDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/certification":{"get":{"tags":["Setup User Certification"],"summary":"List","description":"Retrieve a paginated list of Setup User Certification records. Supports filtering, sorting, and search.","operationId":"setupUserCertificationList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupUserCertification"}},"example":[{"id":12345,"user_id":1,"name":"Example Name","pass_date":"2025-01-17T10:30:00Z","notes":"Sample notes text content","provided_by":"example_provided_by","user_email":"example_user_email"},{"id":12345,"user_id":1,"name":"Example Name","pass_date":"2025-01-17T10:30:00Z","notes":"Sample notes text content","provided_by":"example_provided_by","user_email":"example_user_email"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/changelog":{"get":{"tags":["Change Log"],"summary":"List","description":"Retrieve a paginated list of Change Log records. Supports filtering, sorting, and search.","operationId":"changeLogList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/cluster":{"get":{"tags":["Setup Cluster"],"summary":"List","description":"Retrieve a paginated list of Setup Cluster records. Supports filtering, sorting, and search.","operationId":"setupClusterList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupCluster"}},"example":[{"id":12345,"account_id":1,"name":"Example Name"},{"id":12345,"account_id":1,"name":"Example Name"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Cluster"],"summary":"Create","description":"Create a new Setup Cluster record.","operationId":"setupClusterCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupClusterInput"},"example":{"account_id":1,"name":"Example Name"}}}}}},"/api/cp/setup/cluster/{id}":{"get":{"tags":["Setup Cluster"],"summary":"Read","description":"Retrieve a single Setup Cluster record by ID.","operationId":"setupClusterRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupCluster"},"example":{"id":12345,"account_id":1,"name":"Example Name"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Cluster"],"summary":"Update","description":"Update an existing Setup Cluster record by ID.","operationId":"setupClusterUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupClusterInput"},"example":{"account_id":1,"name":"Example Name"}}}}},"delete":{"tags":["Setup Cluster"],"summary":"Delete","description":"Delete a Setup Cluster record by ID.","operationId":"setupClusterDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/component":{"get":{"tags":["Setup Component"],"summary":"List","description":"Retrieve a paginated list of Setup Component records. Supports filtering, sorting, and search.","operationId":"setupComponentList","parameters":[{"in":"query","name":"graph_type","description":"Filter by Graph Type","required":false,"schema":{"type":"string","enum":["line","area","bar","pie","radar","sankey","gauge"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupComponent"}},"example":[{"id":12345,"account_id":1,"name":"Example Name","path":"example_path","section":"example_section","title":"Example Name","subtitle":"example_subtitle","graph_type":"line","colspan":1,"height":123,"output":"graph","queries":"example_queries","graph":"Sample graph text content","scriptforge_id":1,"analytic_id":1,"pre_processor_script":"Sample pre_processor_script text content"},{"id":12345,"account_id":1,"name":"Example Name","path":"example_path","section":"example_section","title":"Example Name","subtitle":"example_subtitle","graph_type":"line","colspan":1,"height":123,"output":"graph","queries":"example_queries","graph":"Sample graph text content","scriptforge_id":1,"analytic_id":1,"pre_processor_script":"Sample pre_processor_script text content"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Component"],"summary":"Create","description":"Create a new Setup Component record.","operationId":"setupComponentCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupComponentInput"},"example":{"account_id":1,"name":"Example Name","path":"example_path","section":"example_section","title":"Example Name","subtitle":"example_subtitle","graph_type":"line","colspan":1,"height":123,"output":"graph","queries":"example_queries","graph":"Sample graph text content","scriptforge_id":1,"analytic_id":1,"pre_processor_script":"Sample pre_processor_script text content"}}}}}},"/api/cp/setup/component/{id}":{"get":{"tags":["Setup Component"],"summary":"Read","description":"Retrieve a single Setup Component record by ID.","operationId":"setupComponentRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupComponent"},"example":{"id":12345,"account_id":1,"name":"Example Name","path":"example_path","section":"example_section","title":"Example Name","subtitle":"example_subtitle","graph_type":"line","colspan":1,"height":123,"output":"graph","queries":"example_queries","graph":"Sample graph text content","scriptforge_id":1,"analytic_id":1,"pre_processor_script":"Sample pre_processor_script text content"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Component"],"summary":"Update","description":"Update an existing Setup Component record by ID.","operationId":"setupComponentUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupComponentInput"},"example":{"account_id":1,"name":"Example Name","path":"example_path","section":"example_section","title":"Example Name","subtitle":"example_subtitle","graph_type":"line","colspan":1,"height":123,"output":"graph","queries":"example_queries","graph":"Sample graph text content","scriptforge_id":1,"analytic_id":1,"pre_processor_script":"Sample pre_processor_script text content"}}}}},"delete":{"tags":["Setup Component"],"summary":"Delete","description":"Delete a Setup Component record by ID.","operationId":"setupComponentDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/contract":{"get":{"tags":["Setup Contract"],"summary":"List","description":"Retrieve a paginated list of Setup Contract records. Supports filtering, sorting, and search.","operationId":"setupContractList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupContract"}},"example":[{"id":12345,"account_id":1,"name":"Example Name","default":1,"deleted":1,"kyc":1},{"id":12345,"account_id":1,"name":"Example Name","default":1,"deleted":1,"kyc":1}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Contract"],"summary":"Create","description":"Create a new Setup Contract record.","operationId":"setupContractCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupContractInput"},"example":{"account_id":1,"name":"Example Name","default":1,"deleted":1,"kyc":1}}}}}},"/api/cp/setup/contract/{id}":{"get":{"tags":["Setup Contract"],"summary":"Read","description":"Retrieve a single Setup Contract record by ID.","operationId":"setupContractRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupContract"},"example":{"id":12345,"account_id":1,"name":"Example Name","default":1,"deleted":1,"kyc":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Contract"],"summary":"Update","description":"Update an existing Setup Contract record by ID.","operationId":"setupContractUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupContractInput"},"example":{"account_id":1,"name":"Example Name","default":1,"deleted":1,"kyc":1}}}}},"delete":{"tags":["Setup Contract"],"summary":"Delete","description":"Delete a Setup Contract record by ID.","operationId":"setupContractDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/cx-package":{"get":{"tags":["Setup Cx Packages"],"summary":"List","description":"Retrieve a paginated list of Setup Cx Packages records. Supports filtering, sorting, and search.","operationId":"setupCxPackagesList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupCxPackages"}},"example":[{"id":12345,"account_id":1,"cx_package_id":1,"qty":123,"max_daily_qty":123},{"id":12345,"account_id":1,"cx_package_id":1,"qty":123,"max_daily_qty":123}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Cx Packages"],"summary":"Create","description":"Create a new Setup Cx Packages record.","operationId":"setupCxPackagesCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupCxPackagesInput"},"example":{"account_id":1,"cx_package_id":1,"qty":123,"max_daily_qty":123}}}}}},"/api/cp/setup/cx-package/repo":{"get":{"tags":["Setup Cx Packages"],"summary":"Repository","description":"Repository","operationId":"setupCxPackagesRepository","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupCxPackages"},"example":{"id":12345,"account_id":1,"cx_package_id":1,"qty":123,"max_daily_qty":123}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/cx-package/{id}":{"put":{"tags":["Setup Cx Packages"],"summary":"Update","description":"Update an existing Setup Cx Packages record by ID.","operationId":"setupCxPackagesUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupCxPackagesInput"},"example":{"account_id":1,"cx_package_id":1,"qty":123,"max_daily_qty":123}}}}},"delete":{"tags":["Setup Cx Packages"],"summary":"Delete","description":"Delete a Setup Cx Packages record by ID.","operationId":"setupCxPackagesDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/datastore":{"get":{"tags":["Setup Datastore"],"summary":"List","description":"Retrieve a paginated list of Setup Datastore records. Supports filtering, sorting, and search.","operationId":"setupDatastoreList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupDatastore"}}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Datastore"],"summary":"Create","description":"Create a new Setup Datastore record.","operationId":"setupDatastoreCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupDatastoreInput"}}}}}},"/api/cp/setup/datastore/sql":{"post":{"tags":["Setup Datastore"],"summary":"SQL","description":"SQL","operationId":"setupDatastoreSql","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupDatastoreInput"}}}}}},"/api/cp/setup/datastore/{id}":{"get":{"tags":["Setup Datastore"],"summary":"Read","description":"Retrieve a single Setup Datastore record by ID.","operationId":"setupDatastoreRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupDatastore"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"delete":{"tags":["Setup Datastore"],"summary":"Delete","description":"Delete a Setup Datastore record by ID.","operationId":"setupDatastoreDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/delayed":{"get":{"tags":["Setup Delayed"],"summary":"List","description":"Retrieve a paginated list of Setup Delayed records. Supports filtering, sorting, and search.","operationId":"setupDelayedList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/delayed/{id}":{"delete":{"tags":["Setup Delayed"],"summary":"Delete","description":"Delete a Setup Delayed record by ID.","operationId":"setupDelayedDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/dns":{"get":{"tags":["Setup DNS"],"summary":"List","description":"Retrieve a paginated list of Setup DNS records. Supports filtering, sorting, and search.","operationId":"setupDnsList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupDns"}},"example":[{"id":12345,"account_id":1,"domain":"example_domain","a":"example_a","srv_t1":"example_srv_t1","srv_t2":"example_srv_t2","srv_t3":"example_srv_t3","ttl":123,"srv_t1_anyedge_mirror":123,"srv_t2_anyedge_mirror":123,"srv_t3_anyedge_mirror":123},{"id":12345,"account_id":1,"domain":"example_domain","a":"example_a","srv_t1":"example_srv_t1","srv_t2":"example_srv_t2","srv_t3":"example_srv_t3","ttl":123,"srv_t1_anyedge_mirror":123,"srv_t2_anyedge_mirror":123,"srv_t3_anyedge_mirror":123}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup DNS"],"summary":"Create","description":"Create a new Setup DNS record.","operationId":"setupDnsCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupDnsInput"},"example":{"account_id":1,"domain":"example_domain","a":"example_a","srv_t1":"example_srv_t1","srv_t2":"example_srv_t2","srv_t3":"example_srv_t3","ttl":123,"srv_t1_anyedge_mirror":123,"srv_t2_anyedge_mirror":123,"srv_t3_anyedge_mirror":123}}}}}},"/api/cp/setup/dns/tld":{"get":{"tags":["Setup DNS"],"summary":"List TLDs","description":"List TLDs","operationId":"setupDnsListTlDs","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupDns"},"example":{"id":12345,"account_id":1,"domain":"example_domain","a":"example_a","srv_t1":"example_srv_t1","srv_t2":"example_srv_t2","srv_t3":"example_srv_t3","ttl":123,"srv_t1_anyedge_mirror":123,"srv_t2_anyedge_mirror":123,"srv_t3_anyedge_mirror":123}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/dns/{id}":{"get":{"tags":["Setup DNS"],"summary":"Read","description":"Retrieve a single Setup DNS record by ID.","operationId":"setupDnsRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupDns"},"example":{"id":12345,"account_id":1,"domain":"example_domain","a":"example_a","srv_t1":"example_srv_t1","srv_t2":"example_srv_t2","srv_t3":"example_srv_t3","ttl":123,"srv_t1_anyedge_mirror":123,"srv_t2_anyedge_mirror":123,"srv_t3_anyedge_mirror":123}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup DNS"],"summary":"Update","description":"Update an existing Setup DNS record by ID.","operationId":"setupDnsUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupDnsInput"},"example":{"account_id":1,"domain":"example_domain","a":"example_a","srv_t1":"example_srv_t1","srv_t2":"example_srv_t2","srv_t3":"example_srv_t3","ttl":123,"srv_t1_anyedge_mirror":123,"srv_t2_anyedge_mirror":123,"srv_t3_anyedge_mirror":123}}}}},"delete":{"tags":["Setup DNS"],"summary":"Delete","description":"Delete a Setup DNS record by ID.","operationId":"setupDnsDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/document":{"get":{"tags":["Setup Document"],"summary":"List","description":"Retrieve a paginated list of Setup Document records. Supports filtering, sorting, and search.","operationId":"setupDocumentList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupDocument"}},"example":[{"id":12345,"account_id":1,"dt":"2025-01-17T10:30:00Z","name":"Example Name","notes":"Sample notes text content","account_notes":10,"filename":"example_filename"},{"id":12345,"account_id":1,"dt":"2025-01-17T10:30:00Z","name":"Example Name","notes":"Sample notes text content","account_notes":10,"filename":"example_filename"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Document"],"summary":"Create","description":"Create a new Setup Document record.","operationId":"setupDocumentCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupDocumentInput"},"example":{"account_id":1,"dt":"2025-01-17T10:30:00Z","name":"Example Name","notes":"Sample notes text content","account_notes":10,"filename":"example_filename"}}}}}},"/api/cp/setup/document/{id}":{"get":{"tags":["Setup Document"],"summary":"Read","description":"Retrieve a single Setup Document record by ID.","operationId":"setupDocumentRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupDocument"},"example":{"id":12345,"account_id":1,"dt":"2025-01-17T10:30:00Z","name":"Example Name","notes":"Sample notes text content","account_notes":10,"filename":"example_filename"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Document"],"summary":"Update","description":"Update an existing Setup Document record by ID.","operationId":"setupDocumentUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupDocumentInput"},"example":{"account_id":1,"dt":"2025-01-17T10:30:00Z","name":"Example Name","notes":"Sample notes text content","account_notes":10,"filename":"example_filename"}}}}}},"/api/cp/setup/document/{id}/{filename}":{"get":{"tags":["Setup Document"],"summary":"Download","description":"Download","operationId":"setupDocumentDownload","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345},{"in":"path","name":"filename","description":"Filename identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupDocument"},"example":{"id":12345,"account_id":1,"dt":"2025-01-17T10:30:00Z","name":"Example Name","notes":"Sample notes text content","account_notes":10,"filename":"example_filename"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/domain":{"get":{"tags":["Setup Domain"],"summary":"List","description":"Retrieve a paginated list of Setup Domain records. Supports filtering, sorting, and search.","operationId":"setupDomainList","parameters":[{"in":"query","name":"type","description":"Filter by Type","required":false,"schema":{"type":"string","enum":["portal","server"]}},{"in":"query","name":"softphone_deploy_type","description":"Filter by Softphone Deploy Type","required":false,"schema":{"type":"string","enum":["code","sms","existing"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupDomain"}},"example":[{"id":12345,"account_id":1,"domain":"example_domain","brand_name":"example_brand_name","managed":1,"type":"portal","landing_page":"example_landing_page","access":"example_access","feature":"example_feature","prop":"value","carrier_signup":1,"customer_signup":1,"new_customer_defaults":"example_new_customer_defaults","new_customer_debit_limit":99.99,"new_customer_status":"example_new_customer_status","ssl_certificate":"Sample ssl_certificate text content","ssl_certificate_key":"Sample ssl_certificate_key text content","ssl_ca_certificate":"Sample ssl_ca_certificate text content","ssl_cert_request_hash_a":"example_ssl_cert_request_hash_a","ssl_cert_request_hash_b":"example_ssl_cert_request_hash_b","a":"example_a","srv":"example_srv","ttl":123,"template_customer_id":1,"javascript":"Sample javascript text content","css":"Sample css text content","currencies":"example_currencies","cdr_fields":"example_cdr_fields","breakout_fields":"example_breakout_fields","logo":"example_logo","footer":"example_footer","softphone_deploy_type":"code","softphone_signup_fields":"example_softphone_signup_fields","softphone_menu":"Sample softphone_menu text content","softphone_register_success_html":"example_softphone_register_success_html","softphone_host":"example_softphone_host","softphone_flags":"BALANCE","smtp_server":"example_smtp_server","smtp_username":"example_smtp_username","smtp_password":"example_smtp_password","smtp_from_address":"example_smtp_from_address","flags":"example_flags"},{"id":12345,"account_id":1,"domain":"example_domain","brand_name":"example_brand_name","managed":1,"type":"portal","landing_page":"example_landing_page","access":"example_access","feature":"example_feature","prop":"value","carrier_signup":1,"customer_signup":1,"new_customer_defaults":"example_new_customer_defaults","new_customer_debit_limit":99.99,"new_customer_status":"example_new_customer_status","ssl_certificate":"Sample ssl_certificate text content","ssl_certificate_key":"Sample ssl_certificate_key text content","ssl_ca_certificate":"Sample ssl_ca_certificate text content","ssl_cert_request_hash_a":"example_ssl_cert_request_hash_a","ssl_cert_request_hash_b":"example_ssl_cert_request_hash_b","a":"example_a","srv":"example_srv","ttl":123,"template_customer_id":1,"javascript":"Sample javascript text content","css":"Sample css text content","currencies":"example_currencies","cdr_fields":"example_cdr_fields","breakout_fields":"example_breakout_fields","logo":"example_logo","footer":"example_footer","softphone_deploy_type":"code","softphone_signup_fields":"example_softphone_signup_fields","softphone_menu":"Sample softphone_menu text content","softphone_register_success_html":"example_softphone_register_success_html","softphone_host":"example_softphone_host","softphone_flags":"BALANCE","smtp_server":"example_smtp_server","smtp_username":"example_smtp_username","smtp_password":"example_smtp_password","smtp_from_address":"example_smtp_from_address","flags":"example_flags"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Domain"],"summary":"Create","description":"Create a new Setup Domain record.","operationId":"setupDomainCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupDomainInput"},"example":{"account_id":1,"domain":"example_domain","brand_name":"example_brand_name","managed":1,"type":"portal","landing_page":"example_landing_page","access":"example_access","feature":"example_feature","prop":"value","carrier_signup":1,"customer_signup":1,"new_customer_defaults":"example_new_customer_defaults","new_customer_debit_limit":99.99,"new_customer_status":"example_new_customer_status","ssl_certificate":"Sample ssl_certificate text content","ssl_certificate_key":"Sample ssl_certificate_key text content","ssl_ca_certificate":"Sample ssl_ca_certificate text content","ssl_cert_request_hash_a":"example_ssl_cert_request_hash_a","ssl_cert_request_hash_b":"example_ssl_cert_request_hash_b","a":"example_a","srv":"example_srv","ttl":123,"template_customer_id":1,"javascript":"Sample javascript text content","css":"Sample css text content","currencies":"example_currencies","cdr_fields":"example_cdr_fields","breakout_fields":"example_breakout_fields","logo":"example_logo","footer":"example_footer","softphone_deploy_type":"code","softphone_signup_fields":"example_softphone_signup_fields","softphone_menu":"Sample softphone_menu text content","softphone_register_success_html":"example_softphone_register_success_html","softphone_host":"example_softphone_host","softphone_flags":"BALANCE","smtp_server":"example_smtp_server","smtp_username":"example_smtp_username","smtp_password":"example_smtp_password","smtp_from_address":"example_smtp_from_address","flags":"example_flags"}}}}}},"/api/cp/setup/domain/{id}":{"get":{"tags":["Setup Domain"],"summary":"Read","description":"Retrieve a single Setup Domain record by ID.","operationId":"setupDomainRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupDomain"},"example":{"id":12345,"account_id":1,"domain":"example_domain","brand_name":"example_brand_name","managed":1,"type":"portal","landing_page":"example_landing_page","access":"example_access","feature":"example_feature","prop":"value","carrier_signup":1,"customer_signup":1,"new_customer_defaults":"example_new_customer_defaults","new_customer_debit_limit":99.99,"new_customer_status":"example_new_customer_status","ssl_certificate":"Sample ssl_certificate text content","ssl_certificate_key":"Sample ssl_certificate_key text content","ssl_ca_certificate":"Sample ssl_ca_certificate text content","ssl_cert_request_hash_a":"example_ssl_cert_request_hash_a","ssl_cert_request_hash_b":"example_ssl_cert_request_hash_b","a":"example_a","srv":"example_srv","ttl":123,"template_customer_id":1,"javascript":"Sample javascript text content","css":"Sample css text content","currencies":"example_currencies","cdr_fields":"example_cdr_fields","breakout_fields":"example_breakout_fields","logo":"example_logo","footer":"example_footer","softphone_deploy_type":"code","softphone_signup_fields":"example_softphone_signup_fields","softphone_menu":"Sample softphone_menu text content","softphone_register_success_html":"example_softphone_register_success_html","softphone_host":"example_softphone_host","softphone_flags":"BALANCE","smtp_server":"example_smtp_server","smtp_username":"example_smtp_username","smtp_password":"example_smtp_password","smtp_from_address":"example_smtp_from_address","flags":"example_flags"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Domain"],"summary":"Update","description":"Update an existing Setup Domain record by ID.","operationId":"setupDomainUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupDomainInput"},"example":{"account_id":1,"domain":"example_domain","brand_name":"example_brand_name","managed":1,"type":"portal","landing_page":"example_landing_page","access":"example_access","feature":"example_feature","prop":"value","carrier_signup":1,"customer_signup":1,"new_customer_defaults":"example_new_customer_defaults","new_customer_debit_limit":99.99,"new_customer_status":"example_new_customer_status","ssl_certificate":"Sample ssl_certificate text content","ssl_certificate_key":"Sample ssl_certificate_key text content","ssl_ca_certificate":"Sample ssl_ca_certificate text content","ssl_cert_request_hash_a":"example_ssl_cert_request_hash_a","ssl_cert_request_hash_b":"example_ssl_cert_request_hash_b","a":"example_a","srv":"example_srv","ttl":123,"template_customer_id":1,"javascript":"Sample javascript text content","css":"Sample css text content","currencies":"example_currencies","cdr_fields":"example_cdr_fields","breakout_fields":"example_breakout_fields","logo":"example_logo","footer":"example_footer","softphone_deploy_type":"code","softphone_signup_fields":"example_softphone_signup_fields","softphone_menu":"Sample softphone_menu text content","softphone_register_success_html":"example_softphone_register_success_html","softphone_host":"example_softphone_host","softphone_flags":"BALANCE","smtp_server":"example_smtp_server","smtp_username":"example_smtp_username","smtp_password":"example_smtp_password","smtp_from_address":"example_smtp_from_address","flags":"example_flags"}}}}},"delete":{"tags":["Setup Domain"],"summary":"Delete","description":"Delete a Setup Domain record by ID.","operationId":"setupDomainDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/domain/{id}/check":{"get":{"tags":["Setup Domain"],"summary":"Check","description":"Check","operationId":"setupDomainCheck","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupDomain"},"example":{"id":12345,"account_id":1,"domain":"example_domain","brand_name":"example_brand_name","managed":1,"type":"portal","landing_page":"example_landing_page","access":"example_access","feature":"example_feature","prop":"value","carrier_signup":1,"customer_signup":1,"new_customer_defaults":"example_new_customer_defaults","new_customer_debit_limit":99.99,"new_customer_status":"example_new_customer_status","ssl_certificate":"Sample ssl_certificate text content","ssl_certificate_key":"Sample ssl_certificate_key text content","ssl_ca_certificate":"Sample ssl_ca_certificate text content","ssl_cert_request_hash_a":"example_ssl_cert_request_hash_a","ssl_cert_request_hash_b":"example_ssl_cert_request_hash_b","a":"example_a","srv":"example_srv","ttl":123,"template_customer_id":1,"javascript":"Sample javascript text content","css":"Sample css text content","currencies":"example_currencies","cdr_fields":"example_cdr_fields","breakout_fields":"example_breakout_fields","logo":"example_logo","footer":"example_footer","softphone_deploy_type":"code","softphone_signup_fields":"example_softphone_signup_fields","softphone_menu":"Sample softphone_menu text content","softphone_register_success_html":"example_softphone_register_success_html","softphone_host":"example_softphone_host","softphone_flags":"BALANCE","smtp_server":"example_smtp_server","smtp_username":"example_smtp_username","smtp_password":"example_smtp_password","smtp_from_address":"example_smtp_from_address","flags":"example_flags"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/domain/{id}/deploy-cert":{"get":{"tags":["Setup Domain"],"summary":"Deploy Cert","description":"Deploy Cert","operationId":"setupDomainDeployCert","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupDomain"},"example":{"id":12345,"account_id":1,"domain":"example_domain","brand_name":"example_brand_name","managed":1,"type":"portal","landing_page":"example_landing_page","access":"example_access","feature":"example_feature","prop":"value","carrier_signup":1,"customer_signup":1,"new_customer_defaults":"example_new_customer_defaults","new_customer_debit_limit":99.99,"new_customer_status":"example_new_customer_status","ssl_certificate":"Sample ssl_certificate text content","ssl_certificate_key":"Sample ssl_certificate_key text content","ssl_ca_certificate":"Sample ssl_ca_certificate text content","ssl_cert_request_hash_a":"example_ssl_cert_request_hash_a","ssl_cert_request_hash_b":"example_ssl_cert_request_hash_b","a":"example_a","srv":"example_srv","ttl":123,"template_customer_id":1,"javascript":"Sample javascript text content","css":"Sample css text content","currencies":"example_currencies","cdr_fields":"example_cdr_fields","breakout_fields":"example_breakout_fields","logo":"example_logo","footer":"example_footer","softphone_deploy_type":"code","softphone_signup_fields":"example_softphone_signup_fields","softphone_menu":"Sample softphone_menu text content","softphone_register_success_html":"example_softphone_register_success_html","softphone_host":"example_softphone_host","softphone_flags":"BALANCE","smtp_server":"example_smtp_server","smtp_username":"example_smtp_username","smtp_password":"example_smtp_password","smtp_from_address":"example_smtp_from_address","flags":"example_flags"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/firewall":{"get":{"tags":["Setup Firewall"],"summary":"List","description":"Retrieve a paginated list of Setup Firewall records. Supports filtering, sorting, and search.","operationId":"setupFirewallList","parameters":[{"in":"query","name":"action","description":"Filter by Action","required":false,"schema":{"type":"string","enum":["block"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupFirewall"}},"example":[{"id":12345,"account_id":1,"dt":"2025-01-17T10:30:00Z","ip":"192.168.1.1","action":"block","notes":"example_notes"},{"id":12345,"account_id":1,"dt":"2025-01-17T10:30:00Z","ip":"192.168.1.1","action":"block","notes":"example_notes"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Firewall"],"summary":"Create","description":"Create a new Setup Firewall record.","operationId":"setupFirewallCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupFirewallInput"},"example":{"account_id":1,"dt":"2025-01-17T10:30:00Z","ip":"192.168.1.1","action":"block","notes":"example_notes"}}}}}},"/api/cp/setup/firewall/{id}":{"get":{"tags":["Setup Firewall"],"summary":"Read","description":"Retrieve a single Setup Firewall record by ID.","operationId":"setupFirewallRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupFirewall"},"example":{"id":12345,"account_id":1,"dt":"2025-01-17T10:30:00Z","ip":"192.168.1.1","action":"block","notes":"example_notes"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Firewall"],"summary":"Update","description":"Update an existing Setup Firewall record by ID.","operationId":"setupFirewallUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupFirewallInput"},"example":{"account_id":1,"dt":"2025-01-17T10:30:00Z","ip":"192.168.1.1","action":"block","notes":"example_notes"}}}}},"delete":{"tags":["Setup Firewall"],"summary":"Delete","description":"Delete a Setup Firewall record by ID.","operationId":"setupFirewallDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/fraud-profile":{"get":{"tags":["Fraud Profile"],"summary":"List","description":"Retrieve a paginated list of Fraud Profile records. Supports filtering, sorting, and search.","operationId":"fraudProfileList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/fraudProfile"}},"example":[{"id":12345,"account_id":1,"name":"Example Name"},{"id":12345,"account_id":1,"name":"Example Name"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Fraud Profile"],"summary":"Create","description":"Create a new Fraud Profile record.","operationId":"fraudProfileCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/fraudProfileInput"},"example":{"account_id":1,"name":"Example Name"}}}}}},"/api/cp/setup/fraud-profile/{id}":{"get":{"tags":["Fraud Profile"],"summary":"Read","description":"Retrieve a single Fraud Profile record by ID.","operationId":"fraudProfileRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fraudProfile"},"example":{"id":12345,"account_id":1,"name":"Example Name"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Fraud Profile"],"summary":"Update","description":"Update an existing Fraud Profile record by ID.","operationId":"fraudProfileUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/fraudProfileInput"},"example":{"account_id":1,"name":"Example Name"}}}}},"delete":{"tags":["Fraud Profile"],"summary":"Delete","description":"Delete a Fraud Profile record by ID.","operationId":"fraudProfileDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/fraud-rule":{"get":{"tags":["Fraud Rule"],"summary":"List","description":"Retrieve a paginated list of Fraud Rule records. Supports filtering, sorting, and search.","operationId":"fraudRuleList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/fraudRule"}},"example":[{"id":12345,"fraud_profile_id":1,"prefix":"example_prefix","start_hour":"example_start_hour","end_hour":"example_end_hour","daysoftheweek":"example_daysoftheweek","cpm_warning":123,"cpm_critical":123,"call_duration_warning":123,"call_duration_critical":123,"total_calls_warning":10,"total_calls_critical":10,"concurrent_calls_warning":123,"concurrent_calls_critical":123,"sequential_calls_warning":123,"sequential_calls_critical":123},{"id":12345,"fraud_profile_id":1,"prefix":"example_prefix","start_hour":"example_start_hour","end_hour":"example_end_hour","daysoftheweek":"example_daysoftheweek","cpm_warning":123,"cpm_critical":123,"call_duration_warning":123,"call_duration_critical":123,"total_calls_warning":10,"total_calls_critical":10,"concurrent_calls_warning":123,"concurrent_calls_critical":123,"sequential_calls_warning":123,"sequential_calls_critical":123}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Fraud Rule"],"summary":"Create","description":"Create a new Fraud Rule record.","operationId":"fraudRuleCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/fraudRuleInput"},"example":{"fraud_profile_id":1,"prefix":"example_prefix","start_hour":"example_start_hour","end_hour":"example_end_hour","daysoftheweek":"example_daysoftheweek","cpm_warning":123,"cpm_critical":123,"call_duration_warning":123,"call_duration_critical":123,"total_calls_warning":10,"total_calls_critical":10,"concurrent_calls_warning":123,"concurrent_calls_critical":123,"sequential_calls_warning":123,"sequential_calls_critical":123}}}}}},"/api/cp/setup/fraud-rule/{id}":{"get":{"tags":["Fraud Rule"],"summary":"Read","description":"Retrieve a single Fraud Rule record by ID.","operationId":"fraudRuleRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fraudRule"},"example":{"id":12345,"fraud_profile_id":1,"prefix":"example_prefix","start_hour":"example_start_hour","end_hour":"example_end_hour","daysoftheweek":"example_daysoftheweek","cpm_warning":123,"cpm_critical":123,"call_duration_warning":123,"call_duration_critical":123,"total_calls_warning":10,"total_calls_critical":10,"concurrent_calls_warning":123,"concurrent_calls_critical":123,"sequential_calls_warning":123,"sequential_calls_critical":123}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Fraud Rule"],"summary":"Update","description":"Update an existing Fraud Rule record by ID.","operationId":"fraudRuleUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/fraudRuleInput"},"example":{"fraud_profile_id":1,"prefix":"example_prefix","start_hour":"example_start_hour","end_hour":"example_end_hour","daysoftheweek":"example_daysoftheweek","cpm_warning":123,"cpm_critical":123,"call_duration_warning":123,"call_duration_critical":123,"total_calls_warning":10,"total_calls_critical":10,"concurrent_calls_warning":123,"concurrent_calls_critical":123,"sequential_calls_warning":123,"sequential_calls_critical":123}}}}},"delete":{"tags":["Fraud Rule"],"summary":"Delete","description":"Delete a Fraud Rule record by ID.","operationId":"fraudRuleDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/group":{"get":{"tags":["Setup Group"],"summary":"List","description":"Retrieve a paginated list of Setup Group records. Supports filtering, sorting, and search.","operationId":"setupGroupList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupGroup"}},"example":[{"id":12345,"account_id":1,"name":"Example Name","access_customer":1,"access_carrier":1,"access_card":1,"access_carrier_card":1,"access_customer_card":1,"access_cdr":1,"access_log":1,"access_report":1,"access_data":1,"access_pcap":1,"access_default":"get"},{"id":12345,"account_id":1,"name":"Example Name","access_customer":1,"access_carrier":1,"access_card":1,"access_carrier_card":1,"access_customer_card":1,"access_cdr":1,"access_log":1,"access_report":1,"access_data":1,"access_pcap":1,"access_default":"get"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Group"],"summary":"Create","description":"Create a new Setup Group record.","operationId":"setupGroupCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupGroupInput"},"example":{"account_id":1,"name":"Example Name","access_customer":1,"access_carrier":1,"access_card":1,"access_carrier_card":1,"access_customer_card":1,"access_cdr":1,"access_log":1,"access_report":1,"access_data":1,"access_pcap":1,"access_default":"get"}}}}}},"/api/cp/setup/group-permission":{"get":{"tags":["Setup Group Permission"],"summary":"List","description":"Retrieve a paginated list of Setup Group Permission records. Supports filtering, sorting, and search.","operationId":"setupGroupPermissionList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupGroupPermission"}},"example":[{"id":12345,"group_id":1,"path":"example_path","access":"get"},{"id":12345,"group_id":1,"path":"example_path","access":"get"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Group Permission"],"summary":"Create","description":"Create a new Setup Group Permission record.","operationId":"setupGroupPermissionCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupGroupPermissionInput"},"example":{"group_id":1,"path":"example_path","access":"get"}}}}}},"/api/cp/setup/group-permission/{id}":{"get":{"tags":["Setup Group Permission"],"summary":"Read","description":"Retrieve a single Setup Group Permission record by ID.","operationId":"setupGroupPermissionRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupGroupPermission"},"example":{"id":12345,"group_id":1,"path":"example_path","access":"get"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Group Permission"],"summary":"Update","description":"Update an existing Setup Group Permission record by ID.","operationId":"setupGroupPermissionUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupGroupPermissionInput"},"example":{"group_id":1,"path":"example_path","access":"get"}}}}},"delete":{"tags":["Setup Group Permission"],"summary":"Delete","description":"Delete a Setup Group Permission record by ID.","operationId":"setupGroupPermissionDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/group/{id}":{"get":{"tags":["Setup Group"],"summary":"Read","description":"Retrieve a single Setup Group record by ID.","operationId":"setupGroupRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupGroup"},"example":{"id":12345,"account_id":1,"name":"Example Name","access_customer":1,"access_carrier":1,"access_card":1,"access_carrier_card":1,"access_customer_card":1,"access_cdr":1,"access_log":1,"access_report":1,"access_data":1,"access_pcap":1,"access_default":"get"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Group"],"summary":"Update","description":"Update an existing Setup Group record by ID.","operationId":"setupGroupUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupGroupInput"},"example":{"account_id":1,"name":"Example Name","access_customer":1,"access_carrier":1,"access_card":1,"access_carrier_card":1,"access_customer_card":1,"access_cdr":1,"access_log":1,"access_report":1,"access_data":1,"access_pcap":1,"access_default":"get"}}}}},"delete":{"tags":["Setup Group"],"summary":"Delete","description":"Delete a Setup Group record by ID.","operationId":"setupGroupDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/job":{"get":{"tags":["Setup Job"],"summary":"List","description":"Retrieve a paginated list of Setup Job records. Supports filtering, sorting, and search.","operationId":"setupJobList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/job/all":{"get":{"tags":["Setup Job"],"summary":"All Jobs","description":"All Jobs","operationId":"setupJobAllJobs","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/job/{queue}/retry/{jobId([0-9]+)}":{"post":{"tags":["Setup Job"],"summary":"Retry","description":"Retry","operationId":"setupJobRetry","parameters":[{"in":"path","name":"queue","description":"Queue identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"jobId([0-9]+)","description":"Job Id 0 9 identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/job/{queue}/{jobId([0-9]+)}":{"get":{"tags":["Setup Job"],"summary":"View Job","description":"View Job","operationId":"setupJobViewJob","parameters":[{"in":"path","name":"queue","description":"Queue identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"jobId([0-9]+)","description":"Job Id 0 9 identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/job/{queue}/{status(wait|active|delayed|completed|failed)}":{"get":{"tags":["Setup Job"],"summary":"Queues List","description":"Queues List","operationId":"setupJobQueuesList","parameters":[{"in":"path","name":"queue","description":"Queue identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"status(wait|active|delayed|completed|failed)","description":"Status Wait Active Delayed Completed Failed identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/job3":{"get":{"tags":["Jobs (New)"],"summary":"List","description":"Retrieve a paginated list of Jobs (New) records. Supports filtering, sorting, and search.","operationId":"jobsNewList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/jobsNew"}},"example":[{"queue":"Sample queue text content","id":12345,"seq":1000000,"name":"Example Name","state":"example_state","data":"example_data","opts":"example_opts","priority":"example_priority","delay_ms":1000000,"max_attempts":"example_max_attempts","attempts_made":"example_attempts_made","attempts_started":"example_attempts_started","progress":"example_progress","return_value":"example_return_value","failed_reason":"Sample failed_reason text content","stacktrace":"example_stacktrace","deferred_failure":"Sample deferred_failure text content","processed_by":"Sample processed_by text content","added_at_ms":1000000,"process_at_ms":1000000,"processed_at_ms":1000000,"finished_at_ms":1000000,"lock_token":"Sample lock_token text content","locked_until_ms":1000000,"stalled_count":10,"dedup_id":1,"scheduler_id":1,"parent_queue":"Sample parent_queue text content","parent_id":1,"parent_key":"Sample parent_key text content","pending_deps":"example_pending_deps","stalled_marked":"example_stalled_marked"},{"queue":"Sample queue text content","id":12345,"seq":1000000,"name":"Example Name","state":"example_state","data":"example_data","opts":"example_opts","priority":"example_priority","delay_ms":1000000,"max_attempts":"example_max_attempts","attempts_made":"example_attempts_made","attempts_started":"example_attempts_started","progress":"example_progress","return_value":"example_return_value","failed_reason":"Sample failed_reason text content","stacktrace":"example_stacktrace","deferred_failure":"Sample deferred_failure text content","processed_by":"Sample processed_by text content","added_at_ms":1000000,"process_at_ms":1000000,"processed_at_ms":1000000,"finished_at_ms":1000000,"lock_token":"Sample lock_token text content","locked_until_ms":1000000,"stalled_count":10,"dedup_id":1,"scheduler_id":1,"parent_queue":"Sample parent_queue text content","parent_id":1,"parent_key":"Sample parent_key text content","pending_deps":"example_pending_deps","stalled_marked":"example_stalled_marked"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/job3/queues":{"get":{"tags":["Jobs (New)"],"summary":"Queues List","description":"Queues List","operationId":"jobsNewQueuesList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/jobsNew"},"example":{"queue":"Sample queue text content","id":12345,"seq":1000000,"name":"Example Name","state":"example_state","data":"example_data","opts":"example_opts","priority":"example_priority","delay_ms":1000000,"max_attempts":"example_max_attempts","attempts_made":"example_attempts_made","attempts_started":"example_attempts_started","progress":"example_progress","return_value":"example_return_value","failed_reason":"Sample failed_reason text content","stacktrace":"example_stacktrace","deferred_failure":"Sample deferred_failure text content","processed_by":"Sample processed_by text content","added_at_ms":1000000,"process_at_ms":1000000,"processed_at_ms":1000000,"finished_at_ms":1000000,"lock_token":"Sample lock_token text content","locked_until_ms":1000000,"stalled_count":10,"dedup_id":1,"scheduler_id":1,"parent_queue":"Sample parent_queue text content","parent_id":1,"parent_key":"Sample parent_key text content","pending_deps":"example_pending_deps","stalled_marked":"example_stalled_marked"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/job3/{queue}/{id}":{"get":{"tags":["Jobs (New)"],"summary":"Read","description":"Retrieve a single Jobs (New) record by ID.","operationId":"jobsNewRead","parameters":[{"in":"path","name":"queue","description":"Queue identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/jobsNew"},"example":{"queue":"Sample queue text content","id":12345,"seq":1000000,"name":"Example Name","state":"example_state","data":"example_data","opts":"example_opts","priority":"example_priority","delay_ms":1000000,"max_attempts":"example_max_attempts","attempts_made":"example_attempts_made","attempts_started":"example_attempts_started","progress":"example_progress","return_value":"example_return_value","failed_reason":"Sample failed_reason text content","stacktrace":"example_stacktrace","deferred_failure":"Sample deferred_failure text content","processed_by":"Sample processed_by text content","added_at_ms":1000000,"process_at_ms":1000000,"processed_at_ms":1000000,"finished_at_ms":1000000,"lock_token":"Sample lock_token text content","locked_until_ms":1000000,"stalled_count":10,"dedup_id":1,"scheduler_id":1,"parent_queue":"Sample parent_queue text content","parent_id":1,"parent_key":"Sample parent_key text content","pending_deps":"example_pending_deps","stalled_marked":"example_stalled_marked"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Jobs (New)"],"summary":"Retry","description":"Retry","operationId":"jobsNewRetry","parameters":[{"in":"path","name":"queue","description":"Queue identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/jobsNewInput"},"example":{"queue":"Sample queue text content","seq":1000000,"name":"Example Name","state":"example_state","data":"example_data","opts":"example_opts","priority":"example_priority","delay_ms":1000000,"max_attempts":"example_max_attempts","attempts_made":"example_attempts_made","attempts_started":"example_attempts_started","progress":"example_progress","return_value":"example_return_value","failed_reason":"Sample failed_reason text content","stacktrace":"example_stacktrace","deferred_failure":"Sample deferred_failure text content","processed_by":"Sample processed_by text content","added_at_ms":1000000,"process_at_ms":1000000,"processed_at_ms":1000000,"finished_at_ms":1000000,"lock_token":"Sample lock_token text content","locked_until_ms":1000000,"stalled_count":10,"dedup_id":1,"scheduler_id":1,"parent_queue":"Sample parent_queue text content","parent_id":1,"parent_key":"Sample parent_key text content","pending_deps":"example_pending_deps","stalled_marked":"example_stalled_marked"}}}}}},"/api/cp/setup/job3/{queue}/{id}/log":{"get":{"tags":["Jobs (New)"],"summary":"Logs SSE","description":"Logs SSE","operationId":"jobsNewLogsSse","parameters":[{"in":"path","name":"queue","description":"Queue identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/jobsNew"},"example":{"queue":"Sample queue text content","id":12345,"seq":1000000,"name":"Example Name","state":"example_state","data":"example_data","opts":"example_opts","priority":"example_priority","delay_ms":1000000,"max_attempts":"example_max_attempts","attempts_made":"example_attempts_made","attempts_started":"example_attempts_started","progress":"example_progress","return_value":"example_return_value","failed_reason":"Sample failed_reason text content","stacktrace":"example_stacktrace","deferred_failure":"Sample deferred_failure text content","processed_by":"Sample processed_by text content","added_at_ms":1000000,"process_at_ms":1000000,"processed_at_ms":1000000,"finished_at_ms":1000000,"lock_token":"Sample lock_token text content","locked_until_ms":1000000,"stalled_count":10,"dedup_id":1,"scheduler_id":1,"parent_queue":"Sample parent_queue text content","parent_id":1,"parent_key":"Sample parent_key text content","pending_deps":"example_pending_deps","stalled_marked":"example_stalled_marked"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/jwt/session":{"get":{"tags":["JWT Refresh Tokens"],"summary":"Get Session JWT","description":"Get Session JWT","operationId":"jwtRefreshTokensGetSessionJwt","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/jwtRefreshTokens"},"example":{"id":12345,"user_id":1,"account_id":1,"content":"Sample content text content","token_hash":"example_token_hash","jti":"example_jti","audience":"example_audience","expires_at":"2025-01-17T10:30:00Z","created_at":"2025-01-17T10:30:00Z","revoked_at":"2025-01-17T10:30:00Z","device_info":"Sample device_info text content","last_used_at":"2025-01-17T10:30:00Z","type":"refresh"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/key":{"get":{"tags":["Setup Keys"],"summary":"List","description":"Retrieve a paginated list of Setup Keys records. Supports filtering, sorting, and search.","operationId":"setupKeysList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupKeys"}},"example":[{"id":12345,"user_id":1,"name":"Example Name","public_key":"example_public_key"},{"id":12345,"user_id":1,"name":"Example Name","public_key":"example_public_key"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Keys"],"summary":"Create","description":"Create a new Setup Keys record.","operationId":"setupKeysCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupKeysInput"},"example":{"user_id":1,"name":"Example Name","public_key":"example_public_key"}}}}}},"/api/cp/setup/key/{id}":{"get":{"tags":["Setup Keys"],"summary":"Read","description":"Retrieve a single Setup Keys record by ID.","operationId":"setupKeysRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupKeys"},"example":{"id":12345,"user_id":1,"name":"Example Name","public_key":"example_public_key"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Keys"],"summary":"Update","description":"Update an existing Setup Keys record by ID.","operationId":"setupKeysUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupKeysInput"},"example":{"user_id":1,"name":"Example Name","public_key":"example_public_key"}}}}},"delete":{"tags":["Setup Keys"],"summary":"Delete","description":"Delete a Setup Keys record by ID.","operationId":"setupKeysDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/kyb-didit":{"post":{"tags":["KYB Didit"],"summary":"Create","description":"Create a new KYB Didit record.","operationId":"kybDiditCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/kyc":{"get":{"tags":["KYC"],"summary":"List","description":"Retrieve a paginated list of KYC records. Supports filtering, sorting, and search.","operationId":"kycList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["KYC"],"summary":"Create","description":"Create a new KYC record.","operationId":"kycCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/kyc-didit":{"post":{"tags":["KYC Didit"],"summary":"Create","description":"Create a new KYC Didit record.","operationId":"kycDiditCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/lang":{"get":{"tags":["Setup Language"],"summary":"List","description":"Retrieve a paginated list of Setup Language records. Supports filtering, sorting, and search.","operationId":"setupLanguageList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupLanguage"}},"example":[{"id":12345,"key":"example_key","lang":"example_lang","account_id":1,"translation":"example_translation","none":"example_none","single":"example_single","plural":"example_plural"},{"id":12345,"key":"example_key","lang":"example_lang","account_id":1,"translation":"example_translation","none":"example_none","single":"example_single","plural":"example_plural"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Language"],"summary":"Create","description":"Create a new Setup Language record.","operationId":"setupLanguageCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupLanguageInput"},"example":{"key":"example_key","lang":"example_lang","account_id":1,"translation":"example_translation","none":"example_none","single":"example_single","plural":"example_plural"}}}}}},"/api/cp/setup/lang/{id}":{"get":{"tags":["Setup Language"],"summary":"Read","description":"Retrieve a single Setup Language record by ID.","operationId":"setupLanguageRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupLanguage"},"example":{"id":12345,"key":"example_key","lang":"example_lang","account_id":1,"translation":"example_translation","none":"example_none","single":"example_single","plural":"example_plural"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Language"],"summary":"Update","description":"Update an existing Setup Language record by ID.","operationId":"setupLanguageUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupLanguageInput"},"example":{"key":"example_key","lang":"example_lang","account_id":1,"translation":"example_translation","none":"example_none","single":"example_single","plural":"example_plural"}}}}},"delete":{"tags":["Setup Language"],"summary":"Delete","description":"Delete a Setup Language record by ID.","operationId":"setupLanguageDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/number-list":{"get":{"tags":["Setup Number List"],"summary":"List","description":"Retrieve a paginated list of Setup Number List records. Supports filtering, sorting, and search.","operationId":"setupNumberListList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupNumberList"}},"example":[{"list_id":1,"phone_number":1000000,"meta":"Sample meta text content"},{"list_id":1,"phone_number":1000000,"meta":"Sample meta text content"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/number-list(.{ext(csv))}":{"post":{"tags":["Setup Number List"],"summary":"Create","description":"Create a new Setup Number List record.","operationId":"setupNumberListCreate","parameters":[{"in":"path","name":"ext(csv))","description":"Ext Csv identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupNumberListInput"},"example":{"list_id":1,"phone_number":1000000,"meta":"Sample meta text content"}}}}}},"/api/cp/setup/number-list/{id}":{"get":{"tags":["Setup Number List"],"summary":"Read","description":"Retrieve a single Setup Number List record by ID.","operationId":"setupNumberListRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupNumberList"},"example":{"list_id":1,"phone_number":1000000,"meta":"Sample meta text content"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"delete":{"tags":["Setup Number List"],"summary":"Delete","description":"Delete a Setup Number List record by ID.","operationId":"setupNumberListDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/opaque-tokens":{"get":{"tags":["Opaque Tokens"],"summary":"List Opaque Tokens","description":"Lists the calling user's opaque tokens, including revoked and expired ones. The token secret is never returned.","operationId":"opaqueTokensList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Opaque Tokens"],"summary":"Create Opaque Token","description":"Mints an opaque token. The plaintext is returned exactly once and cannot be retrieved again.","operationId":"opaqueTokensCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":128,"description":"User-facing label"},"scope":{"type":"string","pattern":"^(api:read|api:write)( (api:read|api:write))*$","default":"api:read","description":"Space-separated. Self-service creation may only grant: api:read, api:write"},"audience":{"type":"string","description":"Resource to pin the token to. Omit for any allowed resource."},"expires_in":{"type":"integer","minimum":1,"maximum":31536000,"description":"Lifetime in seconds. Omit for a non-expiring token."}}}}}},"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/opaque-tokens/{id}":{"get":{"tags":["Opaque Tokens"],"summary":"Get Opaque Token","description":"Returns one of the calling user's opaque tokens by its hex id. The token secret is never returned.","operationId":"opaqueTokensRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"delete":{"tags":["Opaque Tokens"],"summary":"Revoke Opaque Token","description":"Revokes a token. Idempotent. Takes effect on the next exchange; access tokens already issued from it remain valid until they expire.","operationId":"opaqueTokensDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/package":{"get":{"tags":["Setup Package"],"summary":"List","description":"Retrieve a paginated list of Setup Package records. Supports filtering, sorting, and search.","operationId":"setupPackageList","parameters":[{"in":"query","name":"frequency","description":"Filter by Frequency","required":false,"schema":{"type":"string","enum":["day","week","month","pro_rata"]}},{"in":"query","name":"visibility","description":"Filter by Visibility","required":false,"schema":{"type":"string","enum":["Private","Public"]}},{"in":"query","name":"type","description":"Filter by Type","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupPackage"}},"example":[{"id":12345,"account_id":1,"company_id":1,"name":"Example Name","description":"A detailed description of the resource","area":"example_area","qty":99.99,"retail":99.99,"cost":99.99,"frequency":"day","frequency_match":"example_frequency_match","destination":"example_destination","visibility":"Private","min_spend":1,"min_days":123,"setup_cost":99.99,"setup_retail":99.99,"type":"free-minutes","cx_package_id":1},{"id":12345,"account_id":1,"company_id":1,"name":"Example Name","description":"A detailed description of the resource","area":"example_area","qty":99.99,"retail":99.99,"cost":99.99,"frequency":"day","frequency_match":"example_frequency_match","destination":"example_destination","visibility":"Private","min_spend":1,"min_days":123,"setup_cost":99.99,"setup_retail":99.99,"type":"free-minutes","cx_package_id":1}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Package"],"summary":"Create","description":"Create a new Setup Package record.","operationId":"setupPackageCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupPackageInput"},"example":{"account_id":1,"company_id":1,"name":"Example Name","description":"A detailed description of the resource","area":"example_area","qty":99.99,"retail":99.99,"cost":99.99,"frequency":"day","frequency_match":"example_frequency_match","destination":"example_destination","visibility":"Private","min_spend":1,"min_days":123,"setup_cost":99.99,"setup_retail":99.99,"type":"free-minutes","cx_package_id":1}}}}}},"/api/cp/setup/package/{id}":{"get":{"tags":["Setup Package"],"summary":"Read","description":"Retrieve a single Setup Package record by ID.","operationId":"setupPackageRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupPackage"},"example":{"id":12345,"account_id":1,"company_id":1,"name":"Example Name","description":"A detailed description of the resource","area":"example_area","qty":99.99,"retail":99.99,"cost":99.99,"frequency":"day","frequency_match":"example_frequency_match","destination":"example_destination","visibility":"Private","min_spend":1,"min_days":123,"setup_cost":99.99,"setup_retail":99.99,"type":"free-minutes","cx_package_id":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Package"],"summary":"Update","description":"Update an existing Setup Package record by ID.","operationId":"setupPackageUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupPackageInput"},"example":{"account_id":1,"company_id":1,"name":"Example Name","description":"A detailed description of the resource","area":"example_area","qty":99.99,"retail":99.99,"cost":99.99,"frequency":"day","frequency_match":"example_frequency_match","destination":"example_destination","visibility":"Private","min_spend":1,"min_days":123,"setup_cost":99.99,"setup_retail":99.99,"type":"free-minutes","cx_package_id":1}}}}},"delete":{"tags":["Setup Package"],"summary":"Delete","description":"Delete a Setup Package record by ID.","operationId":"setupPackageDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/page":{"get":{"tags":["Setup Page"],"summary":"List","description":"Retrieve a paginated list of Setup Page records. Supports filtering, sorting, and search.","operationId":"setupPageList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupPage"}},"example":[{"id":12345,"account_id":1,"app_id":1,"name":"Example Name","title":"Example Name","data":"Sample data text content"},{"id":12345,"account_id":1,"app_id":1,"name":"Example Name","title":"Example Name","data":"Sample data text content"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Page"],"summary":"Create","description":"Create a new Setup Page record.","operationId":"setupPageCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupPageInput"},"example":{"account_id":1,"app_id":1,"name":"Example Name","title":"Example Name","data":"Sample data text content"}}}}}},"/api/cp/setup/page/{appId}/{id}":{"get":{"tags":["Setup Page"],"summary":"App Page","description":"App Page","operationId":"setupPageAppPage","parameters":[{"in":"path","name":"appId","description":"App Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupPage"},"example":{"id":12345,"account_id":1,"app_id":1,"name":"Example Name","title":"Example Name","data":"Sample data text content"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/page/{id}":{"get":{"tags":["Setup Page"],"summary":"Read","description":"Retrieve a single Setup Page record by ID.","operationId":"setupPageRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupPage"},"example":{"id":12345,"account_id":1,"app_id":1,"name":"Example Name","title":"Example Name","data":"Sample data text content"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Page"],"summary":"Update","description":"Update an existing Setup Page record by ID.","operationId":"setupPageUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupPageInput"},"example":{"account_id":1,"app_id":1,"name":"Example Name","title":"Example Name","data":"Sample data text content"}}}}},"delete":{"tags":["Setup Page"],"summary":"Delete","description":"Delete a Setup Page record by ID.","operationId":"setupPageDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/passkey":{"get":{"tags":["Setup Passkey"],"summary":"List","description":"Retrieve a paginated list of Setup Passkey records. Supports filtering, sorting, and search.","operationId":"setupPasskeyList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupPasskey"}},"example":[{"id":12345,"name":"Example Name","created_at":"2025-01-17T10:30:00Z","last_used":"2025-01-17T10:30:00Z","device_type":"example_device_type"},{"id":12345,"name":"Example Name","created_at":"2025-01-17T10:30:00Z","last_used":"2025-01-17T10:30:00Z","device_type":"example_device_type"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/passkey/{id}":{"delete":{"tags":["Setup Passkey"],"summary":"Delete","description":"Delete a Setup Passkey record by ID.","operationId":"setupPasskeyDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/payment":{"get":{"tags":["Setup Payment"],"summary":"List","description":"Retrieve a paginated list of Setup Payment records. Supports filtering, sorting, and search.","operationId":"setupPaymentList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupPayment"}},"example":[{"id":12345,"account_id":1,"payment_time":"2025-01-17T10:30:00Z","desc":"example_desc","amount":99.99,"payment_id":1,"charge_id":1,"xero_invoice_id":1,"gbp_amount":99.99},{"id":12345,"account_id":1,"payment_time":"2025-01-17T10:30:00Z","desc":"example_desc","amount":99.99,"payment_id":1,"charge_id":1,"xero_invoice_id":1,"gbp_amount":99.99}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/payment/invoice":{"get":{"tags":["Setup Payment"],"summary":"Invoice","description":"Invoice","operationId":"setupPaymentInvoice","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupPayment"},"example":{"id":12345,"account_id":1,"payment_time":"2025-01-17T10:30:00Z","desc":"example_desc","amount":99.99,"payment_id":1,"charge_id":1,"xero_invoice_id":1,"gbp_amount":99.99}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/payment/invoice/{id.pdf}":{"get":{"tags":["Setup Payment"],"summary":"Invoice Download","description":"Invoice Download","operationId":"setupPaymentInvoiceDownload","parameters":[{"in":"path","name":"id.pdf","description":"Id Pdf identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupPayment"},"example":{"id":12345,"account_id":1,"payment_time":"2025-01-17T10:30:00Z","desc":"example_desc","amount":99.99,"payment_id":1,"charge_id":1,"xero_invoice_id":1,"gbp_amount":99.99}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/payment/paypal":{"post":{"tags":["Setup Payment"],"summary":"Paypal Pay","description":"Paypal Pay","operationId":"setupPaymentPaypalPay","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupPaymentInput"},"example":{"account_id":1,"payment_time":"2025-01-17T10:30:00Z","desc":"example_desc","amount":99.99,"payment_id":1,"charge_id":1,"xero_invoice_id":1,"gbp_amount":99.99}}}}}},"/api/cp/setup/payment/paypal-cancel":{"get":{"tags":["Setup Payment"],"summary":"Paypal Cancel","description":"Paypal Cancel","operationId":"setupPaymentPaypalCancel","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupPayment"},"example":{"id":12345,"account_id":1,"payment_time":"2025-01-17T10:30:00Z","desc":"example_desc","amount":99.99,"payment_id":1,"charge_id":1,"xero_invoice_id":1,"gbp_amount":99.99}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/payment/paypal-return":{"get":{"tags":["Setup Payment"],"summary":"Paypal Return","description":"Paypal Return","operationId":"setupPaymentPaypalReturn","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupPayment"},"example":{"id":12345,"account_id":1,"payment_time":"2025-01-17T10:30:00Z","desc":"example_desc","amount":99.99,"payment_id":1,"charge_id":1,"xero_invoice_id":1,"gbp_amount":99.99}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/payment/stripe/card":{"get":{"tags":["Setup Stripe Card"],"summary":"List","description":"Retrieve a paginated list of Setup Stripe Card records. Supports filtering, sorting, and search.","operationId":"setupStripeCardList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/payment/stripe/card/{id}":{"put":{"tags":["Setup Stripe Card"],"summary":"Update","description":"Update an existing Setup Stripe Card record by ID.","operationId":"setupStripeCardUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"delete":{"tags":["Setup Stripe Card"],"summary":"Delete","description":"Delete a Setup Stripe Card record by ID.","operationId":"setupStripeCardDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/payment/stripe/charge":{"post":{"tags":["Setup Payment"],"summary":"Stripe Charge","description":"Stripe Charge","operationId":"setupPaymentStripeCharge","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupPaymentInput"},"example":{"account_id":1,"payment_time":"2025-01-17T10:30:00Z","desc":"example_desc","amount":99.99,"payment_id":1,"charge_id":1,"xero_invoice_id":1,"gbp_amount":99.99}}}}}},"/api/cp/setup/payment/stripe/checkout":{"post":{"tags":["Setup Payment"],"summary":"Stripe Checkout","description":"Stripe Checkout","operationId":"setupPaymentStripeCheckout","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupPaymentInput"},"example":{"account_id":1,"payment_time":"2025-01-17T10:30:00Z","desc":"example_desc","amount":99.99,"payment_id":1,"charge_id":1,"xero_invoice_id":1,"gbp_amount":99.99}}}}}},"/api/cp/setup/payment/stripe/webhook":{"post":{"tags":["Setup Payment"],"summary":"Stripe Webhook","description":"Stripe Webhook","operationId":"setupPaymentStripeWebhook","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupPaymentInput"},"example":{"account_id":1,"payment_time":"2025-01-17T10:30:00Z","desc":"example_desc","amount":99.99,"payment_id":1,"charge_id":1,"xero_invoice_id":1,"gbp_amount":99.99}}}}}},"/api/cp/setup/payment/verify":{"post":{"tags":["Setup Payment"],"summary":"Verify Payment","description":"Verify Payment","operationId":"setupPaymentVerifyPayment","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupPaymentInput"},"example":{"account_id":1,"payment_time":"2025-01-17T10:30:00Z","desc":"example_desc","amount":99.99,"payment_id":1,"charge_id":1,"xero_invoice_id":1,"gbp_amount":99.99}}}}}},"/api/cp/setup/paypal":{"get":{"tags":["Paypal Log"],"summary":"List","description":"Retrieve a paginated list of Paypal Log records. Supports filtering, sorting, and search.","operationId":"paypalLogList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/prefix-set":{"get":{"tags":["Setup Prefix Set"],"summary":"List","description":"Retrieve a paginated list of Setup Prefix Set records. Supports filtering, sorting, and search.","operationId":"setupPrefixSetList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupPrefixSet"}},"example":[{"id":12345,"account_id":1,"company_id":1,"name":"Example Name","data":"Sample data text content","query":"Sample query text content","flags":"GLOBAL_DN"},{"id":12345,"account_id":1,"company_id":1,"name":"Example Name","data":"Sample data text content","query":"Sample query text content","flags":"GLOBAL_DN"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Prefix Set"],"summary":"Create","description":"Create a new Setup Prefix Set record.","operationId":"setupPrefixSetCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupPrefixSetInput"},"example":{"account_id":1,"company_id":1,"name":"Example Name","data":"Sample data text content","query":"Sample query text content","flags":"GLOBAL_DN"}}}}}},"/api/cp/setup/prefix-set/{id}":{"get":{"tags":["Setup Prefix Set"],"summary":"Read","description":"Retrieve a single Setup Prefix Set record by ID.","operationId":"setupPrefixSetRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupPrefixSet"},"example":{"id":12345,"account_id":1,"company_id":1,"name":"Example Name","data":"Sample data text content","query":"Sample query text content","flags":"GLOBAL_DN"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Prefix Set"],"summary":"Update","description":"Update an existing Setup Prefix Set record by ID.","operationId":"setupPrefixSetUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupPrefixSetInput"},"example":{"account_id":1,"company_id":1,"name":"Example Name","data":"Sample data text content","query":"Sample query text content","flags":"GLOBAL_DN"}}}}},"delete":{"tags":["Setup Prefix Set"],"summary":"Delete","description":"Delete a Setup Prefix Set record by ID.","operationId":"setupPrefixSetDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/queries/{id}":{"delete":{"tags":["Active Queries"],"summary":"Kill Query","description":"Kill Query","operationId":"activeQueriesKillQuery","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/query":{"get":{"tags":["Setup Query"],"summary":"List","description":"Retrieve a paginated list of Setup Query records. Supports filtering, sorting, and search.","operationId":"setupQueryList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupQuery"}},"example":[{"id":12345,"account_id":1,"app_id":1,"name":"Example Name","query":"Sample query text content","src":"example_src","vars":"example_vars"},{"id":12345,"account_id":1,"app_id":1,"name":"Example Name","query":"Sample query text content","src":"example_src","vars":"example_vars"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Query"],"summary":"Create","description":"Create a new Setup Query record.","operationId":"setupQueryCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupQueryInput"},"example":{"account_id":1,"app_id":1,"name":"Example Name","query":"Sample query text content","src":"example_src","vars":"example_vars"}}}}}},"/api/cp/setup/query/system":{"get":{"tags":["Setup Query"],"summary":"System Reports","description":"System Reports","operationId":"setupQuerySystemReports","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupQuery"},"example":{"id":12345,"account_id":1,"app_id":1,"name":"Example Name","query":"Sample query text content","src":"example_src","vars":"example_vars"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/query/{id}":{"get":{"tags":["Setup Query"],"summary":"Read","description":"Retrieve a single Setup Query record by ID.","operationId":"setupQueryRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupQuery"},"example":{"id":12345,"account_id":1,"app_id":1,"name":"Example Name","query":"Sample query text content","src":"example_src","vars":"example_vars"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Query"],"summary":"Update","description":"Update an existing Setup Query record by ID.","operationId":"setupQueryUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupQueryInput"},"example":{"account_id":1,"app_id":1,"name":"Example Name","query":"Sample query text content","src":"example_src","vars":"example_vars"}}}}},"delete":{"tags":["Setup Query"],"summary":"Delete","description":"Delete a Setup Query record by ID.","operationId":"setupQueryDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/query/{id}/run":{"get":{"tags":["Setup Query"],"summary":"Run Query (GET)","description":"Run Query (GET)","operationId":"setupQueryRunQueryGet","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupQuery"},"example":{"id":12345,"account_id":1,"app_id":1,"name":"Example Name","query":"Sample query text content","src":"example_src","vars":"example_vars"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Query"],"summary":"Run Query (POST)","description":"Run Query (POST)","operationId":"setupQueryRunQueryPost","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupQueryInput"},"example":{"account_id":1,"app_id":1,"name":"Example Name","query":"Sample query text content","src":"example_src","vars":"example_vars"}}}}}},"/api/cp/setup/repo":{"get":{"tags":["Setup Repo"],"summary":"List","description":"Retrieve a paginated list of Setup Repo records. Supports filtering, sorting, and search.","operationId":"setupRepoList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupRepo"}},"example":[{"id":12345,"account_id":1,"project_id":1,"name":"Example Name","version":"example_version","approved":1,"published_date":"2025-01-17T10:30:00Z","commit_message":"example_commit_message"},{"id":12345,"account_id":1,"project_id":1,"name":"Example Name","version":"example_version","approved":1,"published_date":"2025-01-17T10:30:00Z","commit_message":"example_commit_message"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/repo/install/{id}":{"post":{"tags":["Setup Repo"],"summary":"Install","description":"Install","operationId":"setupRepoInstall","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupRepoInput"},"example":{"account_id":1,"project_id":1,"name":"Example Name","version":"example_version","approved":1,"published_date":"2025-01-17T10:30:00Z","commit_message":"example_commit_message"}}}}}},"/api/cp/setup/reseller":{"get":{"tags":["Setup Reseller"],"summary":"List","description":"Retrieve a paginated list of Setup Reseller records. Supports filtering, sorting, and search.","operationId":"setupResellerList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupReseller"}},"example":[{"id":12345,"account_id":1,"name":"Example Name","email":"user@example.com","credit":99.99},{"id":12345,"account_id":1,"name":"Example Name","email":"user@example.com","credit":99.99}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Reseller"],"summary":"Create","description":"Create a new Setup Reseller record.","operationId":"setupResellerCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupResellerInput"},"example":{"account_id":1,"name":"Example Name","email":"user@example.com","credit":99.99}}}}}},"/api/cp/setup/reseller/{id}":{"get":{"tags":["Setup Reseller"],"summary":"Read","description":"Retrieve a single Setup Reseller record by ID.","operationId":"setupResellerRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupReseller"},"example":{"id":12345,"account_id":1,"name":"Example Name","email":"user@example.com","credit":99.99}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Reseller"],"summary":"Update","description":"Update an existing Setup Reseller record by ID.","operationId":"setupResellerUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupResellerInput"},"example":{"account_id":1,"name":"Example Name","email":"user@example.com","credit":99.99}}}}},"delete":{"tags":["Setup Reseller"],"summary":"Delete","description":"Delete a Setup Reseller record by ID.","operationId":"setupResellerDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/roadmap":{"get":{"tags":["Road Map"],"summary":"List","description":"Retrieve a paginated list of Road Map records. Supports filtering, sorting, and search.","operationId":"roadMapList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Road Map"],"summary":"Create","description":"Create a new Road Map record.","operationId":"roadMapCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/roadmap/{id}":{"get":{"tags":["Road Map"],"summary":"Read","description":"Retrieve a single Road Map record by ID.","operationId":"roadMapRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Road Map"],"summary":"Update","description":"Update an existing Road Map record by ID.","operationId":"roadMapUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/roadmap/{id}/comment":{"post":{"tags":["Road Map"],"summary":"Add Comment","description":"Add Comment","operationId":"roadMapAddComment","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/rtp":{"get":{"tags":["Setup RTP"],"summary":"List","description":"Retrieve a paginated list of Setup RTP records. Supports filtering, sorting, and search.","operationId":"setupRtpList","parameters":[{"in":"query","name":"type","description":"Filter by Type","required":false,"schema":{"type":"string","enum":["Database","Switch","Cache","Dispatcher","RTP","PBX","SIPTest","Javascript","Web","Other","3CX","Any-Dispatcher","Registrar","Turn","AnyEdge-Dev","AnyRTP-Control","AnyRTP-Actuator","Box"]}},{"in":"query","name":"status","description":"Filter by Status","required":false,"schema":{"type":"string","enum":["Active","Failed","Paused","Unallocated","Expired","Installing","Upgrading"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupRtp"}},"example":[{"ip":"192.168.1.1","ipv6":"example_ipv6","alias":"example_alias"},{"ip":"192.168.1.1","ipv6":"example_ipv6","alias":"example_alias"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/rtp-block":{"get":{"tags":["Setup RTP Block"],"summary":"List","description":"Retrieve a paginated list of Setup RTP Block records. Supports filtering, sorting, and search.","operationId":"setupRtpBlockList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupRtpBlock"}},"example":[{"id":12345,"account_id":1,"ip":"192.168.1.1","cidr":"example_cidr","from_ip":123,"to_ip":123,"flags":"CUSTOMER_IN","notes":"example_notes"},{"id":12345,"account_id":1,"ip":"192.168.1.1","cidr":"example_cidr","from_ip":123,"to_ip":123,"flags":"CUSTOMER_IN","notes":"example_notes"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup RTP Block"],"summary":"Create","description":"Create a new Setup RTP Block record.","operationId":"setupRtpBlockCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupRtpBlockInput"},"example":{"account_id":1,"ip":"192.168.1.1","cidr":"example_cidr","from_ip":123,"to_ip":123,"flags":"CUSTOMER_IN","notes":"example_notes"}}}}}},"/api/cp/setup/rtp-block/{id}":{"get":{"tags":["Setup RTP Block"],"summary":"Read","description":"Retrieve a single Setup RTP Block record by ID.","operationId":"setupRtpBlockRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupRtpBlock"},"example":{"id":12345,"account_id":1,"ip":"192.168.1.1","cidr":"example_cidr","from_ip":123,"to_ip":123,"flags":"CUSTOMER_IN","notes":"example_notes"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup RTP Block"],"summary":"Update","description":"Update an existing Setup RTP Block record by ID.","operationId":"setupRtpBlockUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupRtpBlockInput"},"example":{"account_id":1,"ip":"192.168.1.1","cidr":"example_cidr","from_ip":123,"to_ip":123,"flags":"CUSTOMER_IN","notes":"example_notes"}}}}},"delete":{"tags":["Setup RTP Block"],"summary":"Delete","description":"Delete a Setup RTP Block record by ID.","operationId":"setupRtpBlockDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/rtp-zone":{"get":{"tags":["Setup RTP Zone"],"summary":"List","description":"Retrieve a paginated list of Setup RTP Zone records. Supports filtering, sorting, and search.","operationId":"setupRtpZoneList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupRtpZone"}},"example":[{"id":12345,"account_id":1,"rtp_group_id":1},{"id":12345,"account_id":1,"rtp_group_id":1}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup RTP Zone"],"summary":"Create","description":"Create a new Setup RTP Zone record.","operationId":"setupRtpZoneCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupRtpZoneInput"},"example":{"account_id":1,"rtp_group_id":1}}}}}},"/api/cp/setup/rtp-zone/{id}":{"get":{"tags":["Setup RTP Zone"],"summary":"Read","description":"Retrieve a single Setup RTP Zone record by ID.","operationId":"setupRtpZoneRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupRtpZone"},"example":{"id":12345,"account_id":1,"rtp_group_id":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup RTP Zone"],"summary":"Update","description":"Update an existing Setup RTP Zone record by ID.","operationId":"setupRtpZoneUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupRtpZoneInput"},"example":{"account_id":1,"rtp_group_id":1}}}}},"delete":{"tags":["Setup RTP Zone"],"summary":"Delete","description":"Delete a Setup RTP Zone record by ID.","operationId":"setupRtpZoneDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/server":{"get":{"tags":["Setup Server"],"summary":"List","description":"Retrieve a paginated list of Setup Server records. Supports filtering, sorting, and search.","operationId":"setupServerList","parameters":[{"in":"query","name":"type","description":"Filter by Type","required":false,"schema":{"type":"string","enum":["Database","Switch","Cache","Dispatcher","RTP","PBX","SIPTest","Javascript","Web","Other","3CX","Any-Dispatcher","Registrar","Turn","AnyEdge-Dev","AnyRTP-Control","AnyRTP-Actuator","Box"]}},{"in":"query","name":"status","description":"Filter by Status","required":false,"schema":{"type":"string","enum":["Active","Failed","Paused","Unallocated","Expired","Installing","Upgrading"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupServer"}},"example":[{"id":12345,"account_id":1,"type":"Database","ip":"192.168.1.1","ipv6":"example_ipv6","alias":"example_alias","status":"Active","managed":1,"ssh_user":"example_ssh_user","ssh_password":"example_ssh_password","port":123,"interconnect_form":"termination-ingress","rtp_groups":"example_rtp_groups","channels":123,"cps":123,"rtp_capacity":123,"last_activity":1000000,"platform":"example_platform","expire_date":"2025-01-17T10:30:00Z","cost":99.99,"setting":"base64-encoded-data","setting_json":"Sample setting_json text content","capacity_302":"example_capacity_302","cpu_count":10,"ram":123,"s_mem":123,"p_mem":123,"processes":123,"last_call":"2025-01-17T10:30:00Z","location":"example_location","provider_id":1,"rack_info":"example_rack_info","detailed_spec":"example_detailed_spec","disk_size":"example_disk_size","fqdn":"example_fqdn","stale":1,"startup_time":"2025-01-17T10:30:00Z","approved_delete":"example_approved_delete","internal_ip":"example_internal_ip","tinc_private_key":"example_tinc_private_key","tinc_public_key":"example_tinc_public_key","upgrade_scheduled":"2025-01-17T10:30:00Z","cluster_id":1,"image_slug":"example_image_slug","size_slug":"example_size_slug","last_provision":"2025-01-17T10:30:00Z","created_date":"2025-01-17T10:30:00Z","flags":"example_flags","routing_zone":"example_routing_zone","tasks":"example_tasks","registrar":"example_registrar","ansible_toml":"Sample ansible_toml text content","last_deploy":"2025-01-17T10:30:00Z","certs":"example_certs","provider_cost_usd":99.99,"min_cost":99.99,"peak_min_cost":99.99,"cpu_benchmark":1000000,"box_id":1,"last_resize":"2025-01-17","max_30_day_channels":123,"policy_cohort_id":1},{"id":12345,"account_id":1,"type":"Database","ip":"192.168.1.1","ipv6":"example_ipv6","alias":"example_alias","status":"Active","managed":1,"ssh_user":"example_ssh_user","ssh_password":"example_ssh_password","port":123,"interconnect_form":"termination-ingress","rtp_groups":"example_rtp_groups","channels":123,"cps":123,"rtp_capacity":123,"last_activity":1000000,"platform":"example_platform","expire_date":"2025-01-17T10:30:00Z","cost":99.99,"setting":"base64-encoded-data","setting_json":"Sample setting_json text content","capacity_302":"example_capacity_302","cpu_count":10,"ram":123,"s_mem":123,"p_mem":123,"processes":123,"last_call":"2025-01-17T10:30:00Z","location":"example_location","provider_id":1,"rack_info":"example_rack_info","detailed_spec":"example_detailed_spec","disk_size":"example_disk_size","fqdn":"example_fqdn","stale":1,"startup_time":"2025-01-17T10:30:00Z","approved_delete":"example_approved_delete","internal_ip":"example_internal_ip","tinc_private_key":"example_tinc_private_key","tinc_public_key":"example_tinc_public_key","upgrade_scheduled":"2025-01-17T10:30:00Z","cluster_id":1,"image_slug":"example_image_slug","size_slug":"example_size_slug","last_provision":"2025-01-17T10:30:00Z","created_date":"2025-01-17T10:30:00Z","flags":"example_flags","routing_zone":"example_routing_zone","tasks":"example_tasks","registrar":"example_registrar","ansible_toml":"Sample ansible_toml text content","last_deploy":"2025-01-17T10:30:00Z","certs":"example_certs","provider_cost_usd":99.99,"min_cost":99.99,"peak_min_cost":99.99,"cpu_benchmark":1000000,"box_id":1,"last_resize":"2025-01-17","max_30_day_channels":123,"policy_cohort_id":1}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Server"],"summary":"Create","description":"Create a new Setup Server record.","operationId":"setupServerCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupServerInput"},"example":{"account_id":1,"type":"Database","ip":"192.168.1.1","ipv6":"example_ipv6","alias":"example_alias","status":"Active","managed":1,"ssh_user":"example_ssh_user","ssh_password":"example_ssh_password","port":123,"interconnect_form":"termination-ingress","rtp_groups":"example_rtp_groups","channels":123,"cps":123,"rtp_capacity":123,"last_activity":1000000,"platform":"example_platform","expire_date":"2025-01-17T10:30:00Z","cost":99.99,"setting":"base64-encoded-data","setting_json":"Sample setting_json text content","capacity_302":"example_capacity_302","cpu_count":10,"ram":123,"s_mem":123,"p_mem":123,"processes":123,"last_call":"2025-01-17T10:30:00Z","location":"example_location","provider_id":1,"rack_info":"example_rack_info","detailed_spec":"example_detailed_spec","disk_size":"example_disk_size","fqdn":"example_fqdn","stale":1,"startup_time":"2025-01-17T10:30:00Z","approved_delete":"example_approved_delete","internal_ip":"example_internal_ip","tinc_private_key":"example_tinc_private_key","tinc_public_key":"example_tinc_public_key","upgrade_scheduled":"2025-01-17T10:30:00Z","cluster_id":1,"image_slug":"example_image_slug","size_slug":"example_size_slug","last_provision":"2025-01-17T10:30:00Z","created_date":"2025-01-17T10:30:00Z","flags":"example_flags","routing_zone":"example_routing_zone","tasks":"example_tasks","registrar":"example_registrar","ansible_toml":"Sample ansible_toml text content","last_deploy":"2025-01-17T10:30:00Z","certs":"example_certs","provider_cost_usd":99.99,"min_cost":99.99,"peak_min_cost":99.99,"cpu_benchmark":1000000,"box_id":1,"last_resize":"2025-01-17","max_30_day_channels":123,"policy_cohort_id":1}}}}}},"/api/cp/setup/server-cert":{"get":{"tags":["Setup Servercert"],"summary":"List","description":"Retrieve a paginated list of Setup Servercert records. Supports filtering, sorting, and search.","operationId":"setupServercertList","parameters":[{"in":"query","name":"type","description":"Filter by Type","required":false,"schema":{"type":"string","enum":["client","server"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupServercert"}},"example":[{"id":12345,"server_id":1,"cert_id":1,"type":"client","method":"example_method","verify_cert":1,"require_cert":1,"cipher_list":"example_cipher_list","ec_curve":"example_ec_curve","dh_params":"Sample dh_params text content","match_sip_domain":"example_match_sip_domain"},{"id":12345,"server_id":1,"cert_id":1,"type":"client","method":"example_method","verify_cert":1,"require_cert":1,"cipher_list":"example_cipher_list","ec_curve":"example_ec_curve","dh_params":"Sample dh_params text content","match_sip_domain":"example_match_sip_domain"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Servercert"],"summary":"Create","description":"Create a new Setup Servercert record.","operationId":"setupServercertCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupServercertInput"},"example":{"server_id":1,"cert_id":1,"type":"client","method":"example_method","verify_cert":1,"require_cert":1,"cipher_list":"example_cipher_list","ec_curve":"example_ec_curve","dh_params":"Sample dh_params text content","match_sip_domain":"example_match_sip_domain"}}}}}},"/api/cp/setup/server-cert/{id}":{"get":{"tags":["Setup Servercert"],"summary":"Read","description":"Retrieve a single Setup Servercert record by ID.","operationId":"setupServercertRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupServercert"},"example":{"id":12345,"server_id":1,"cert_id":1,"type":"client","method":"example_method","verify_cert":1,"require_cert":1,"cipher_list":"example_cipher_list","ec_curve":"example_ec_curve","dh_params":"Sample dh_params text content","match_sip_domain":"example_match_sip_domain"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Servercert"],"summary":"Update","description":"Update an existing Setup Servercert record by ID.","operationId":"setupServercertUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupServercertInput"},"example":{"server_id":1,"cert_id":1,"type":"client","method":"example_method","verify_cert":1,"require_cert":1,"cipher_list":"example_cipher_list","ec_curve":"example_ec_curve","dh_params":"Sample dh_params text content","match_sip_domain":"example_match_sip_domain"}}}}},"delete":{"tags":["Setup Servercert"],"summary":"Delete","description":"Delete a Setup Servercert record by ID.","operationId":"setupServercertDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/server/deploy":{"post":{"tags":["Setup Server"],"summary":"Deploy","description":"Deploy","operationId":"setupServerDeploy","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupServerInput"},"example":{"account_id":1,"type":"Database","ip":"192.168.1.1","ipv6":"example_ipv6","alias":"example_alias","status":"Active","managed":1,"ssh_user":"example_ssh_user","ssh_password":"example_ssh_password","port":123,"interconnect_form":"termination-ingress","rtp_groups":"example_rtp_groups","channels":123,"cps":123,"rtp_capacity":123,"last_activity":1000000,"platform":"example_platform","expire_date":"2025-01-17T10:30:00Z","cost":99.99,"setting":"base64-encoded-data","setting_json":"Sample setting_json text content","capacity_302":"example_capacity_302","cpu_count":10,"ram":123,"s_mem":123,"p_mem":123,"processes":123,"last_call":"2025-01-17T10:30:00Z","location":"example_location","provider_id":1,"rack_info":"example_rack_info","detailed_spec":"example_detailed_spec","disk_size":"example_disk_size","fqdn":"example_fqdn","stale":1,"startup_time":"2025-01-17T10:30:00Z","approved_delete":"example_approved_delete","internal_ip":"example_internal_ip","tinc_private_key":"example_tinc_private_key","tinc_public_key":"example_tinc_public_key","upgrade_scheduled":"2025-01-17T10:30:00Z","cluster_id":1,"image_slug":"example_image_slug","size_slug":"example_size_slug","last_provision":"2025-01-17T10:30:00Z","created_date":"2025-01-17T10:30:00Z","flags":"example_flags","routing_zone":"example_routing_zone","tasks":"example_tasks","registrar":"example_registrar","ansible_toml":"Sample ansible_toml text content","last_deploy":"2025-01-17T10:30:00Z","certs":"example_certs","provider_cost_usd":99.99,"min_cost":99.99,"peak_min_cost":99.99,"cpu_benchmark":1000000,"box_id":1,"last_resize":"2025-01-17","max_30_day_channels":123,"policy_cohort_id":1}}}}}},"/api/cp/setup/server/pbx":{"get":{"tags":["Setup Server"],"summary":"PBX","description":"PBX","operationId":"setupServerPbx","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupServer"},"example":{"id":12345,"account_id":1,"type":"Database","ip":"192.168.1.1","ipv6":"example_ipv6","alias":"example_alias","status":"Active","managed":1,"ssh_user":"example_ssh_user","ssh_password":"example_ssh_password","port":123,"interconnect_form":"termination-ingress","rtp_groups":"example_rtp_groups","channels":123,"cps":123,"rtp_capacity":123,"last_activity":1000000,"platform":"example_platform","expire_date":"2025-01-17T10:30:00Z","cost":99.99,"setting":"base64-encoded-data","setting_json":"Sample setting_json text content","capacity_302":"example_capacity_302","cpu_count":10,"ram":123,"s_mem":123,"p_mem":123,"processes":123,"last_call":"2025-01-17T10:30:00Z","location":"example_location","provider_id":1,"rack_info":"example_rack_info","detailed_spec":"example_detailed_spec","disk_size":"example_disk_size","fqdn":"example_fqdn","stale":1,"startup_time":"2025-01-17T10:30:00Z","approved_delete":"example_approved_delete","internal_ip":"example_internal_ip","tinc_private_key":"example_tinc_private_key","tinc_public_key":"example_tinc_public_key","upgrade_scheduled":"2025-01-17T10:30:00Z","cluster_id":1,"image_slug":"example_image_slug","size_slug":"example_size_slug","last_provision":"2025-01-17T10:30:00Z","created_date":"2025-01-17T10:30:00Z","flags":"example_flags","routing_zone":"example_routing_zone","tasks":"example_tasks","registrar":"example_registrar","ansible_toml":"Sample ansible_toml text content","last_deploy":"2025-01-17T10:30:00Z","certs":"example_certs","provider_cost_usd":99.99,"min_cost":99.99,"peak_min_cost":99.99,"cpu_benchmark":1000000,"box_id":1,"last_resize":"2025-01-17","max_30_day_channels":123,"policy_cohort_id":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/server/ping":{"get":{"tags":["Setup Server"],"summary":"Ping","description":"Ping","operationId":"setupServerPing","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupServer"},"example":{"id":12345,"account_id":1,"type":"Database","ip":"192.168.1.1","ipv6":"example_ipv6","alias":"example_alias","status":"Active","managed":1,"ssh_user":"example_ssh_user","ssh_password":"example_ssh_password","port":123,"interconnect_form":"termination-ingress","rtp_groups":"example_rtp_groups","channels":123,"cps":123,"rtp_capacity":123,"last_activity":1000000,"platform":"example_platform","expire_date":"2025-01-17T10:30:00Z","cost":99.99,"setting":"base64-encoded-data","setting_json":"Sample setting_json text content","capacity_302":"example_capacity_302","cpu_count":10,"ram":123,"s_mem":123,"p_mem":123,"processes":123,"last_call":"2025-01-17T10:30:00Z","location":"example_location","provider_id":1,"rack_info":"example_rack_info","detailed_spec":"example_detailed_spec","disk_size":"example_disk_size","fqdn":"example_fqdn","stale":1,"startup_time":"2025-01-17T10:30:00Z","approved_delete":"example_approved_delete","internal_ip":"example_internal_ip","tinc_private_key":"example_tinc_private_key","tinc_public_key":"example_tinc_public_key","upgrade_scheduled":"2025-01-17T10:30:00Z","cluster_id":1,"image_slug":"example_image_slug","size_slug":"example_size_slug","last_provision":"2025-01-17T10:30:00Z","created_date":"2025-01-17T10:30:00Z","flags":"example_flags","routing_zone":"example_routing_zone","tasks":"example_tasks","registrar":"example_registrar","ansible_toml":"Sample ansible_toml text content","last_deploy":"2025-01-17T10:30:00Z","certs":"example_certs","provider_cost_usd":99.99,"min_cost":99.99,"peak_min_cost":99.99,"cpu_benchmark":1000000,"box_id":1,"last_resize":"2025-01-17","max_30_day_channels":123,"policy_cohort_id":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/server/rtp":{"get":{"tags":["Setup Server"],"summary":"RTP","description":"RTP","operationId":"setupServerRtp","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupServer"},"example":{"id":12345,"account_id":1,"type":"Database","ip":"192.168.1.1","ipv6":"example_ipv6","alias":"example_alias","status":"Active","managed":1,"ssh_user":"example_ssh_user","ssh_password":"example_ssh_password","port":123,"interconnect_form":"termination-ingress","rtp_groups":"example_rtp_groups","channels":123,"cps":123,"rtp_capacity":123,"last_activity":1000000,"platform":"example_platform","expire_date":"2025-01-17T10:30:00Z","cost":99.99,"setting":"base64-encoded-data","setting_json":"Sample setting_json text content","capacity_302":"example_capacity_302","cpu_count":10,"ram":123,"s_mem":123,"p_mem":123,"processes":123,"last_call":"2025-01-17T10:30:00Z","location":"example_location","provider_id":1,"rack_info":"example_rack_info","detailed_spec":"example_detailed_spec","disk_size":"example_disk_size","fqdn":"example_fqdn","stale":1,"startup_time":"2025-01-17T10:30:00Z","approved_delete":"example_approved_delete","internal_ip":"example_internal_ip","tinc_private_key":"example_tinc_private_key","tinc_public_key":"example_tinc_public_key","upgrade_scheduled":"2025-01-17T10:30:00Z","cluster_id":1,"image_slug":"example_image_slug","size_slug":"example_size_slug","last_provision":"2025-01-17T10:30:00Z","created_date":"2025-01-17T10:30:00Z","flags":"example_flags","routing_zone":"example_routing_zone","tasks":"example_tasks","registrar":"example_registrar","ansible_toml":"Sample ansible_toml text content","last_deploy":"2025-01-17T10:30:00Z","certs":"example_certs","provider_cost_usd":99.99,"min_cost":99.99,"peak_min_cost":99.99,"cpu_benchmark":1000000,"box_id":1,"last_resize":"2025-01-17","max_30_day_channels":123,"policy_cohort_id":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/server/rtp-group":{"get":{"tags":["Setup Server"],"summary":"RTP Groups","description":"RTP Groups","operationId":"setupServerRtpGroups","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupServer"},"example":{"id":12345,"account_id":1,"type":"Database","ip":"192.168.1.1","ipv6":"example_ipv6","alias":"example_alias","status":"Active","managed":1,"ssh_user":"example_ssh_user","ssh_password":"example_ssh_password","port":123,"interconnect_form":"termination-ingress","rtp_groups":"example_rtp_groups","channels":123,"cps":123,"rtp_capacity":123,"last_activity":1000000,"platform":"example_platform","expire_date":"2025-01-17T10:30:00Z","cost":99.99,"setting":"base64-encoded-data","setting_json":"Sample setting_json text content","capacity_302":"example_capacity_302","cpu_count":10,"ram":123,"s_mem":123,"p_mem":123,"processes":123,"last_call":"2025-01-17T10:30:00Z","location":"example_location","provider_id":1,"rack_info":"example_rack_info","detailed_spec":"example_detailed_spec","disk_size":"example_disk_size","fqdn":"example_fqdn","stale":1,"startup_time":"2025-01-17T10:30:00Z","approved_delete":"example_approved_delete","internal_ip":"example_internal_ip","tinc_private_key":"example_tinc_private_key","tinc_public_key":"example_tinc_public_key","upgrade_scheduled":"2025-01-17T10:30:00Z","cluster_id":1,"image_slug":"example_image_slug","size_slug":"example_size_slug","last_provision":"2025-01-17T10:30:00Z","created_date":"2025-01-17T10:30:00Z","flags":"example_flags","routing_zone":"example_routing_zone","tasks":"example_tasks","registrar":"example_registrar","ansible_toml":"Sample ansible_toml text content","last_deploy":"2025-01-17T10:30:00Z","certs":"example_certs","provider_cost_usd":99.99,"min_cost":99.99,"peak_min_cost":99.99,"cpu_benchmark":1000000,"box_id":1,"last_resize":"2025-01-17","max_30_day_channels":123,"policy_cohort_id":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/server/zones":{"get":{"tags":["Setup Server"],"summary":"Zones","description":"Zones","operationId":"setupServerZones","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupServer"},"example":{"id":12345,"account_id":1,"type":"Database","ip":"192.168.1.1","ipv6":"example_ipv6","alias":"example_alias","status":"Active","managed":1,"ssh_user":"example_ssh_user","ssh_password":"example_ssh_password","port":123,"interconnect_form":"termination-ingress","rtp_groups":"example_rtp_groups","channels":123,"cps":123,"rtp_capacity":123,"last_activity":1000000,"platform":"example_platform","expire_date":"2025-01-17T10:30:00Z","cost":99.99,"setting":"base64-encoded-data","setting_json":"Sample setting_json text content","capacity_302":"example_capacity_302","cpu_count":10,"ram":123,"s_mem":123,"p_mem":123,"processes":123,"last_call":"2025-01-17T10:30:00Z","location":"example_location","provider_id":1,"rack_info":"example_rack_info","detailed_spec":"example_detailed_spec","disk_size":"example_disk_size","fqdn":"example_fqdn","stale":1,"startup_time":"2025-01-17T10:30:00Z","approved_delete":"example_approved_delete","internal_ip":"example_internal_ip","tinc_private_key":"example_tinc_private_key","tinc_public_key":"example_tinc_public_key","upgrade_scheduled":"2025-01-17T10:30:00Z","cluster_id":1,"image_slug":"example_image_slug","size_slug":"example_size_slug","last_provision":"2025-01-17T10:30:00Z","created_date":"2025-01-17T10:30:00Z","flags":"example_flags","routing_zone":"example_routing_zone","tasks":"example_tasks","registrar":"example_registrar","ansible_toml":"Sample ansible_toml text content","last_deploy":"2025-01-17T10:30:00Z","certs":"example_certs","provider_cost_usd":99.99,"min_cost":99.99,"peak_min_cost":99.99,"cpu_benchmark":1000000,"box_id":1,"last_resize":"2025-01-17","max_30_day_channels":123,"policy_cohort_id":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/server/{id}":{"get":{"tags":["Setup Server"],"summary":"Read","description":"Retrieve a single Setup Server record by ID.","operationId":"setupServerRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupServer"},"example":{"id":12345,"account_id":1,"type":"Database","ip":"192.168.1.1","ipv6":"example_ipv6","alias":"example_alias","status":"Active","managed":1,"ssh_user":"example_ssh_user","ssh_password":"example_ssh_password","port":123,"interconnect_form":"termination-ingress","rtp_groups":"example_rtp_groups","channels":123,"cps":123,"rtp_capacity":123,"last_activity":1000000,"platform":"example_platform","expire_date":"2025-01-17T10:30:00Z","cost":99.99,"setting":"base64-encoded-data","setting_json":"Sample setting_json text content","capacity_302":"example_capacity_302","cpu_count":10,"ram":123,"s_mem":123,"p_mem":123,"processes":123,"last_call":"2025-01-17T10:30:00Z","location":"example_location","provider_id":1,"rack_info":"example_rack_info","detailed_spec":"example_detailed_spec","disk_size":"example_disk_size","fqdn":"example_fqdn","stale":1,"startup_time":"2025-01-17T10:30:00Z","approved_delete":"example_approved_delete","internal_ip":"example_internal_ip","tinc_private_key":"example_tinc_private_key","tinc_public_key":"example_tinc_public_key","upgrade_scheduled":"2025-01-17T10:30:00Z","cluster_id":1,"image_slug":"example_image_slug","size_slug":"example_size_slug","last_provision":"2025-01-17T10:30:00Z","created_date":"2025-01-17T10:30:00Z","flags":"example_flags","routing_zone":"example_routing_zone","tasks":"example_tasks","registrar":"example_registrar","ansible_toml":"Sample ansible_toml text content","last_deploy":"2025-01-17T10:30:00Z","certs":"example_certs","provider_cost_usd":99.99,"min_cost":99.99,"peak_min_cost":99.99,"cpu_benchmark":1000000,"box_id":1,"last_resize":"2025-01-17","max_30_day_channels":123,"policy_cohort_id":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Server"],"summary":"Update","description":"Update an existing Setup Server record by ID.","operationId":"setupServerUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupServerInput"},"example":{"account_id":1,"type":"Database","ip":"192.168.1.1","ipv6":"example_ipv6","alias":"example_alias","status":"Active","managed":1,"ssh_user":"example_ssh_user","ssh_password":"example_ssh_password","port":123,"interconnect_form":"termination-ingress","rtp_groups":"example_rtp_groups","channels":123,"cps":123,"rtp_capacity":123,"last_activity":1000000,"platform":"example_platform","expire_date":"2025-01-17T10:30:00Z","cost":99.99,"setting":"base64-encoded-data","setting_json":"Sample setting_json text content","capacity_302":"example_capacity_302","cpu_count":10,"ram":123,"s_mem":123,"p_mem":123,"processes":123,"last_call":"2025-01-17T10:30:00Z","location":"example_location","provider_id":1,"rack_info":"example_rack_info","detailed_spec":"example_detailed_spec","disk_size":"example_disk_size","fqdn":"example_fqdn","stale":1,"startup_time":"2025-01-17T10:30:00Z","approved_delete":"example_approved_delete","internal_ip":"example_internal_ip","tinc_private_key":"example_tinc_private_key","tinc_public_key":"example_tinc_public_key","upgrade_scheduled":"2025-01-17T10:30:00Z","cluster_id":1,"image_slug":"example_image_slug","size_slug":"example_size_slug","last_provision":"2025-01-17T10:30:00Z","created_date":"2025-01-17T10:30:00Z","flags":"example_flags","routing_zone":"example_routing_zone","tasks":"example_tasks","registrar":"example_registrar","ansible_toml":"Sample ansible_toml text content","last_deploy":"2025-01-17T10:30:00Z","certs":"example_certs","provider_cost_usd":99.99,"min_cost":99.99,"peak_min_cost":99.99,"cpu_benchmark":1000000,"box_id":1,"last_resize":"2025-01-17","max_30_day_channels":123,"policy_cohort_id":1}}}}},"delete":{"tags":["Setup Server"],"summary":"Delete","description":"Delete a Setup Server record by ID.","operationId":"setupServerDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/server/{id}/install":{"get":{"tags":["Setup Server"],"summary":"Install Server (Legacy GET)","description":"Install Server (Legacy GET)","operationId":"setupServerInstallServerLegacyGet","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupServer"},"example":{"id":12345,"account_id":1,"type":"Database","ip":"192.168.1.1","ipv6":"example_ipv6","alias":"example_alias","status":"Active","managed":1,"ssh_user":"example_ssh_user","ssh_password":"example_ssh_password","port":123,"interconnect_form":"termination-ingress","rtp_groups":"example_rtp_groups","channels":123,"cps":123,"rtp_capacity":123,"last_activity":1000000,"platform":"example_platform","expire_date":"2025-01-17T10:30:00Z","cost":99.99,"setting":"base64-encoded-data","setting_json":"Sample setting_json text content","capacity_302":"example_capacity_302","cpu_count":10,"ram":123,"s_mem":123,"p_mem":123,"processes":123,"last_call":"2025-01-17T10:30:00Z","location":"example_location","provider_id":1,"rack_info":"example_rack_info","detailed_spec":"example_detailed_spec","disk_size":"example_disk_size","fqdn":"example_fqdn","stale":1,"startup_time":"2025-01-17T10:30:00Z","approved_delete":"example_approved_delete","internal_ip":"example_internal_ip","tinc_private_key":"example_tinc_private_key","tinc_public_key":"example_tinc_public_key","upgrade_scheduled":"2025-01-17T10:30:00Z","cluster_id":1,"image_slug":"example_image_slug","size_slug":"example_size_slug","last_provision":"2025-01-17T10:30:00Z","created_date":"2025-01-17T10:30:00Z","flags":"example_flags","routing_zone":"example_routing_zone","tasks":"example_tasks","registrar":"example_registrar","ansible_toml":"Sample ansible_toml text content","last_deploy":"2025-01-17T10:30:00Z","certs":"example_certs","provider_cost_usd":99.99,"min_cost":99.99,"peak_min_cost":99.99,"cpu_benchmark":1000000,"box_id":1,"last_resize":"2025-01-17","max_30_day_channels":123,"policy_cohort_id":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Server"],"summary":"Install Server","description":"Install Server","operationId":"setupServerInstallServer","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupServerInput"},"example":{"account_id":1,"type":"Database","ip":"192.168.1.1","ipv6":"example_ipv6","alias":"example_alias","status":"Active","managed":1,"ssh_user":"example_ssh_user","ssh_password":"example_ssh_password","port":123,"interconnect_form":"termination-ingress","rtp_groups":"example_rtp_groups","channels":123,"cps":123,"rtp_capacity":123,"last_activity":1000000,"platform":"example_platform","expire_date":"2025-01-17T10:30:00Z","cost":99.99,"setting":"base64-encoded-data","setting_json":"Sample setting_json text content","capacity_302":"example_capacity_302","cpu_count":10,"ram":123,"s_mem":123,"p_mem":123,"processes":123,"last_call":"2025-01-17T10:30:00Z","location":"example_location","provider_id":1,"rack_info":"example_rack_info","detailed_spec":"example_detailed_spec","disk_size":"example_disk_size","fqdn":"example_fqdn","stale":1,"startup_time":"2025-01-17T10:30:00Z","approved_delete":"example_approved_delete","internal_ip":"example_internal_ip","tinc_private_key":"example_tinc_private_key","tinc_public_key":"example_tinc_public_key","upgrade_scheduled":"2025-01-17T10:30:00Z","cluster_id":1,"image_slug":"example_image_slug","size_slug":"example_size_slug","last_provision":"2025-01-17T10:30:00Z","created_date":"2025-01-17T10:30:00Z","flags":"example_flags","routing_zone":"example_routing_zone","tasks":"example_tasks","registrar":"example_registrar","ansible_toml":"Sample ansible_toml text content","last_deploy":"2025-01-17T10:30:00Z","certs":"example_certs","provider_cost_usd":99.99,"min_cost":99.99,"peak_min_cost":99.99,"cpu_benchmark":1000000,"box_id":1,"last_resize":"2025-01-17","max_30_day_channels":123,"policy_cohort_id":1}}}}}},"/api/cp/setup/server/{id}/network-mtr":{"post":{"tags":["Setup Server"],"summary":"Network MTR","description":"Network MTR","operationId":"setupServerNetworkMtr","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupServerInput"},"example":{"account_id":1,"type":"Database","ip":"192.168.1.1","ipv6":"example_ipv6","alias":"example_alias","status":"Active","managed":1,"ssh_user":"example_ssh_user","ssh_password":"example_ssh_password","port":123,"interconnect_form":"termination-ingress","rtp_groups":"example_rtp_groups","channels":123,"cps":123,"rtp_capacity":123,"last_activity":1000000,"platform":"example_platform","expire_date":"2025-01-17T10:30:00Z","cost":99.99,"setting":"base64-encoded-data","setting_json":"Sample setting_json text content","capacity_302":"example_capacity_302","cpu_count":10,"ram":123,"s_mem":123,"p_mem":123,"processes":123,"last_call":"2025-01-17T10:30:00Z","location":"example_location","provider_id":1,"rack_info":"example_rack_info","detailed_spec":"example_detailed_spec","disk_size":"example_disk_size","fqdn":"example_fqdn","stale":1,"startup_time":"2025-01-17T10:30:00Z","approved_delete":"example_approved_delete","internal_ip":"example_internal_ip","tinc_private_key":"example_tinc_private_key","tinc_public_key":"example_tinc_public_key","upgrade_scheduled":"2025-01-17T10:30:00Z","cluster_id":1,"image_slug":"example_image_slug","size_slug":"example_size_slug","last_provision":"2025-01-17T10:30:00Z","created_date":"2025-01-17T10:30:00Z","flags":"example_flags","routing_zone":"example_routing_zone","tasks":"example_tasks","registrar":"example_registrar","ansible_toml":"Sample ansible_toml text content","last_deploy":"2025-01-17T10:30:00Z","certs":"example_certs","provider_cost_usd":99.99,"min_cost":99.99,"peak_min_cost":99.99,"cpu_benchmark":1000000,"box_id":1,"last_resize":"2025-01-17","max_30_day_channels":123,"policy_cohort_id":1}}}}}},"/api/cp/setup/server/{id}/network-ping":{"post":{"tags":["Setup Server"],"summary":"Network Ping","description":"Network Ping","operationId":"setupServerNetworkPing","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupServerInput"},"example":{"account_id":1,"type":"Database","ip":"192.168.1.1","ipv6":"example_ipv6","alias":"example_alias","status":"Active","managed":1,"ssh_user":"example_ssh_user","ssh_password":"example_ssh_password","port":123,"interconnect_form":"termination-ingress","rtp_groups":"example_rtp_groups","channels":123,"cps":123,"rtp_capacity":123,"last_activity":1000000,"platform":"example_platform","expire_date":"2025-01-17T10:30:00Z","cost":99.99,"setting":"base64-encoded-data","setting_json":"Sample setting_json text content","capacity_302":"example_capacity_302","cpu_count":10,"ram":123,"s_mem":123,"p_mem":123,"processes":123,"last_call":"2025-01-17T10:30:00Z","location":"example_location","provider_id":1,"rack_info":"example_rack_info","detailed_spec":"example_detailed_spec","disk_size":"example_disk_size","fqdn":"example_fqdn","stale":1,"startup_time":"2025-01-17T10:30:00Z","approved_delete":"example_approved_delete","internal_ip":"example_internal_ip","tinc_private_key":"example_tinc_private_key","tinc_public_key":"example_tinc_public_key","upgrade_scheduled":"2025-01-17T10:30:00Z","cluster_id":1,"image_slug":"example_image_slug","size_slug":"example_size_slug","last_provision":"2025-01-17T10:30:00Z","created_date":"2025-01-17T10:30:00Z","flags":"example_flags","routing_zone":"example_routing_zone","tasks":"example_tasks","registrar":"example_registrar","ansible_toml":"Sample ansible_toml text content","last_deploy":"2025-01-17T10:30:00Z","certs":"example_certs","provider_cost_usd":99.99,"min_cost":99.99,"peak_min_cost":99.99,"cpu_benchmark":1000000,"box_id":1,"last_resize":"2025-01-17","max_30_day_channels":123,"policy_cohort_id":1}}}}}},"/api/cp/setup/server/{id}/reactivate":{"post":{"tags":["Setup Server"],"summary":"Reactivate Server","description":"Reactivate Server","operationId":"setupServerReactivateServer","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupServerInput"},"example":{"account_id":1,"type":"Database","ip":"192.168.1.1","ipv6":"example_ipv6","alias":"example_alias","status":"Active","managed":1,"ssh_user":"example_ssh_user","ssh_password":"example_ssh_password","port":123,"interconnect_form":"termination-ingress","rtp_groups":"example_rtp_groups","channels":123,"cps":123,"rtp_capacity":123,"last_activity":1000000,"platform":"example_platform","expire_date":"2025-01-17T10:30:00Z","cost":99.99,"setting":"base64-encoded-data","setting_json":"Sample setting_json text content","capacity_302":"example_capacity_302","cpu_count":10,"ram":123,"s_mem":123,"p_mem":123,"processes":123,"last_call":"2025-01-17T10:30:00Z","location":"example_location","provider_id":1,"rack_info":"example_rack_info","detailed_spec":"example_detailed_spec","disk_size":"example_disk_size","fqdn":"example_fqdn","stale":1,"startup_time":"2025-01-17T10:30:00Z","approved_delete":"example_approved_delete","internal_ip":"example_internal_ip","tinc_private_key":"example_tinc_private_key","tinc_public_key":"example_tinc_public_key","upgrade_scheduled":"2025-01-17T10:30:00Z","cluster_id":1,"image_slug":"example_image_slug","size_slug":"example_size_slug","last_provision":"2025-01-17T10:30:00Z","created_date":"2025-01-17T10:30:00Z","flags":"example_flags","routing_zone":"example_routing_zone","tasks":"example_tasks","registrar":"example_registrar","ansible_toml":"Sample ansible_toml text content","last_deploy":"2025-01-17T10:30:00Z","certs":"example_certs","provider_cost_usd":99.99,"min_cost":99.99,"peak_min_cost":99.99,"cpu_benchmark":1000000,"box_id":1,"last_resize":"2025-01-17","max_30_day_channels":123,"policy_cohort_id":1}}}}}},"/api/cp/setup/server/{id}/resize":{"post":{"tags":["Setup Server"],"summary":"Resize Server","description":"Resize Server","operationId":"setupServerResizeServer","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupServerInput"},"example":{"account_id":1,"type":"Database","ip":"192.168.1.1","ipv6":"example_ipv6","alias":"example_alias","status":"Active","managed":1,"ssh_user":"example_ssh_user","ssh_password":"example_ssh_password","port":123,"interconnect_form":"termination-ingress","rtp_groups":"example_rtp_groups","channels":123,"cps":123,"rtp_capacity":123,"last_activity":1000000,"platform":"example_platform","expire_date":"2025-01-17T10:30:00Z","cost":99.99,"setting":"base64-encoded-data","setting_json":"Sample setting_json text content","capacity_302":"example_capacity_302","cpu_count":10,"ram":123,"s_mem":123,"p_mem":123,"processes":123,"last_call":"2025-01-17T10:30:00Z","location":"example_location","provider_id":1,"rack_info":"example_rack_info","detailed_spec":"example_detailed_spec","disk_size":"example_disk_size","fqdn":"example_fqdn","stale":1,"startup_time":"2025-01-17T10:30:00Z","approved_delete":"example_approved_delete","internal_ip":"example_internal_ip","tinc_private_key":"example_tinc_private_key","tinc_public_key":"example_tinc_public_key","upgrade_scheduled":"2025-01-17T10:30:00Z","cluster_id":1,"image_slug":"example_image_slug","size_slug":"example_size_slug","last_provision":"2025-01-17T10:30:00Z","created_date":"2025-01-17T10:30:00Z","flags":"example_flags","routing_zone":"example_routing_zone","tasks":"example_tasks","registrar":"example_registrar","ansible_toml":"Sample ansible_toml text content","last_deploy":"2025-01-17T10:30:00Z","certs":"example_certs","provider_cost_usd":99.99,"min_cost":99.99,"peak_min_cost":99.99,"cpu_benchmark":1000000,"box_id":1,"last_resize":"2025-01-17","max_30_day_channels":123,"policy_cohort_id":1}}}}}},"/api/cp/setup/server/{id}/{action(start|stop|restart|power-cycle|os-cycle)}":{"get":{"tags":["Setup Server"],"summary":"Service Action","description":"Service Action","operationId":"setupServerServiceAction","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345},{"in":"path","name":"action(start|stop|restart|power-cycle|os-cycle)","description":"Action Start Stop Restart Power Cycle Os Cycle identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupServer"},"example":{"id":12345,"account_id":1,"type":"Database","ip":"192.168.1.1","ipv6":"example_ipv6","alias":"example_alias","status":"Active","managed":1,"ssh_user":"example_ssh_user","ssh_password":"example_ssh_password","port":123,"interconnect_form":"termination-ingress","rtp_groups":"example_rtp_groups","channels":123,"cps":123,"rtp_capacity":123,"last_activity":1000000,"platform":"example_platform","expire_date":"2025-01-17T10:30:00Z","cost":99.99,"setting":"base64-encoded-data","setting_json":"Sample setting_json text content","capacity_302":"example_capacity_302","cpu_count":10,"ram":123,"s_mem":123,"p_mem":123,"processes":123,"last_call":"2025-01-17T10:30:00Z","location":"example_location","provider_id":1,"rack_info":"example_rack_info","detailed_spec":"example_detailed_spec","disk_size":"example_disk_size","fqdn":"example_fqdn","stale":1,"startup_time":"2025-01-17T10:30:00Z","approved_delete":"example_approved_delete","internal_ip":"example_internal_ip","tinc_private_key":"example_tinc_private_key","tinc_public_key":"example_tinc_public_key","upgrade_scheduled":"2025-01-17T10:30:00Z","cluster_id":1,"image_slug":"example_image_slug","size_slug":"example_size_slug","last_provision":"2025-01-17T10:30:00Z","created_date":"2025-01-17T10:30:00Z","flags":"example_flags","routing_zone":"example_routing_zone","tasks":"example_tasks","registrar":"example_registrar","ansible_toml":"Sample ansible_toml text content","last_deploy":"2025-01-17T10:30:00Z","certs":"example_certs","provider_cost_usd":99.99,"min_cost":99.99,"peak_min_cost":99.99,"cpu_benchmark":1000000,"box_id":1,"last_resize":"2025-01-17","max_30_day_channels":123,"policy_cohort_id":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/sign":{"get":{"tags":["Sign"],"summary":"List","description":"Retrieve a paginated list of Sign records. Supports filtering, sorting, and search.","operationId":"signList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Sign"],"summary":"Create","description":"Create a new Sign record.","operationId":"signCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/sign/{id}":{"get":{"tags":["Sign"],"summary":"Read","description":"Retrieve a single Sign record by ID.","operationId":"signRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/sign/{id}/resend":{"post":{"tags":["Sign"],"summary":"Resend Email","description":"Resend Email","operationId":"signResendEmail","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/sign/{requestId}/doc/{id}":{"get":{"tags":["Sign"],"summary":"Download Document","description":"Download Document","operationId":"signDownloadDocument","parameters":[{"in":"path","name":"requestId","description":"Request Id identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/sip-profile":{"get":{"tags":["Setup SIP Profile"],"summary":"List","description":"Retrieve a paginated list of Setup SIP Profile records. Supports filtering, sorting, and search.","operationId":"setupSipProfileList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupSipProfile"}},"example":[{"id":12345,"account_id":1,"name":"Example Name","webphone_licence":123,"flags":"example_flags","profile_capacity":123,"barge_group":"example_barge_group","pbx_server":"example_pbx_server"},{"id":12345,"account_id":1,"name":"Example Name","webphone_licence":123,"flags":"example_flags","profile_capacity":123,"barge_group":"example_barge_group","pbx_server":"example_pbx_server"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup SIP Profile"],"summary":"Create","description":"Create a new Setup SIP Profile record.","operationId":"setupSipProfileCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupSipProfileInput"},"example":{"account_id":1,"name":"Example Name","webphone_licence":123,"flags":"example_flags","profile_capacity":123,"barge_group":"example_barge_group","pbx_server":"example_pbx_server"}}}}}},"/api/cp/setup/sip-profile/{id}":{"get":{"tags":["Setup SIP Profile"],"summary":"Read","description":"Retrieve a single Setup SIP Profile record by ID.","operationId":"setupSipProfileRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupSipProfile"},"example":{"id":12345,"account_id":1,"name":"Example Name","webphone_licence":123,"flags":"example_flags","profile_capacity":123,"barge_group":"example_barge_group","pbx_server":"example_pbx_server"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup SIP Profile"],"summary":"Update","description":"Update an existing Setup SIP Profile record by ID.","operationId":"setupSipProfileUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupSipProfileInput"},"example":{"account_id":1,"name":"Example Name","webphone_licence":123,"flags":"example_flags","profile_capacity":123,"barge_group":"example_barge_group","pbx_server":"example_pbx_server"}}}}},"delete":{"tags":["Setup SIP Profile"],"summary":"Delete","description":"Delete a Setup SIP Profile record by ID.","operationId":"setupSipProfileDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/statement":{"get":{"tags":["Setup Statement"],"summary":"Statement","description":"Statement","operationId":"setupStatementStatement","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/statement/billed-units/{date}":{"get":{"tags":["Setup Statement"],"summary":"Billed Units","description":"Billed Units","operationId":"setupStatementBilledUnits","parameters":[{"in":"path","name":"date","description":"Date identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/statement/server":{"get":{"tags":["Setup Statement"],"summary":"Server Statement","description":"Server Statement","operationId":"setupStatementServerStatement","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/stir-shaken-cert":{"get":{"tags":["Setup Stir Shaken Cert"],"summary":"List","description":"Retrieve a paginated list of Setup Stir Shaken Cert records. Supports filtering, sorting, and search.","operationId":"setupStirShakenCertList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupStirShakenCert"}},"example":[{"id":12345,"account_id":1,"name":"Example Name","cert":"Sample cert text content","key":"Sample key text content","old_id":1},{"id":12345,"account_id":1,"name":"Example Name","cert":"Sample cert text content","key":"Sample key text content","old_id":1}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Stir Shaken Cert"],"summary":"Create","description":"Create a new Setup Stir Shaken Cert record.","operationId":"setupStirShakenCertCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupStirShakenCertInput"},"example":{"account_id":1,"name":"Example Name","cert":"Sample cert text content","key":"Sample key text content","old_id":1}}}}}},"/api/cp/setup/stir-shaken-cert/migrate":{"post":{"tags":["Setup Stir Shaken Cert"],"summary":"Migrate Stir Shaken Cert","description":"Migrate Stir Shaken Cert","operationId":"setupStirShakenCertMigrateStirShakenCert","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupStirShakenCertInput"},"example":{"account_id":1,"name":"Example Name","cert":"Sample cert text content","key":"Sample key text content","old_id":1}}}}}},"/api/cp/setup/stir-shaken-cert/{id}":{"get":{"tags":["Setup Stir Shaken Cert"],"summary":"Read","description":"Retrieve a single Setup Stir Shaken Cert record by ID.","operationId":"setupStirShakenCertRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupStirShakenCert"},"example":{"id":12345,"account_id":1,"name":"Example Name","cert":"Sample cert text content","key":"Sample key text content","old_id":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/stripe-webhook":{"get":{"tags":["Setup Stripe Webhook"],"summary":"Accounts","description":"Accounts","operationId":"setupStripeWebhookAccounts","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/stripe-webhook/{external_api_id}":{"get":{"tags":["Setup Stripe Webhook"],"summary":"List","description":"Retrieve a paginated list of Setup Stripe Webhook records. Supports filtering, sorting, and search.","operationId":"setupStripeWebhookList","parameters":[{"in":"path","name":"external_api_id","description":"External Api Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Stripe Webhook"],"summary":"Create","description":"Create a new Setup Stripe Webhook record.","operationId":"setupStripeWebhookCreate","parameters":[{"in":"path","name":"external_api_id","description":"External Api Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/stripe-webhook/{external_api_id}/{id}":{"get":{"tags":["Setup Stripe Webhook"],"summary":"Read","description":"Retrieve a single Setup Stripe Webhook record by ID.","operationId":"setupStripeWebhookRead","parameters":[{"in":"path","name":"external_api_id","description":"External Api Id identifier","required":true,"schema":{"type":"integer"},"example":12345},{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Stripe Webhook"],"summary":"Update","description":"Update an existing Setup Stripe Webhook record by ID.","operationId":"setupStripeWebhookUpdate","parameters":[{"in":"path","name":"external_api_id","description":"External Api Id identifier","required":true,"schema":{"type":"integer"},"example":12345},{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"delete":{"tags":["Setup Stripe Webhook"],"summary":"Delete","description":"Delete a Setup Stripe Webhook record by ID.","operationId":"setupStripeWebhookDelete","parameters":[{"in":"path","name":"external_api_id","description":"External Api Id identifier","required":true,"schema":{"type":"integer"},"example":12345},{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/system-log/query":{"get":{"tags":["Setup System Log"],"summary":"Query","description":"Query","operationId":"setupSystemLogQuery","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/system-log/tail":{"get":{"tags":["Setup System Log"],"summary":"Tail SSE","description":"Tail SSE","operationId":"setupSystemLogTailSse","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"socket":{"tags":["Setup System Log"],"summary":"Tail Socket","description":"Tail Socket","operationId":"setupSystemLogTailSocket","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/template":{"get":{"tags":["Setup Template"],"summary":"List","description":"Retrieve a paginated list of Setup Template records. Supports filtering, sorting, and search.","operationId":"setupTemplateList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupTemplate"}},"example":[{"id":12345,"account_id":1,"company_id":1,"app_id":1,"name":"Example Name","subject":"example_subject","text":"Sample text text content","html":"Sample html text content","sms":"example_sms","script":"Sample script text content"},{"id":12345,"account_id":1,"company_id":1,"app_id":1,"name":"Example Name","subject":"example_subject","text":"Sample text text content","html":"Sample html text content","sms":"example_sms","script":"Sample script text content"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Template"],"summary":"Create","description":"Create a new Setup Template record.","operationId":"setupTemplateCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupTemplateInput"},"example":{"account_id":1,"company_id":1,"app_id":1,"name":"Example Name","subject":"example_subject","text":"Sample text text content","html":"Sample html text content","sms":"example_sms","script":"Sample script text content"}}}}}},"/api/cp/setup/template/{id}":{"get":{"tags":["Setup Template"],"summary":"Read","description":"Retrieve a single Setup Template record by ID.","operationId":"setupTemplateRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupTemplate"},"example":{"id":12345,"account_id":1,"company_id":1,"app_id":1,"name":"Example Name","subject":"example_subject","text":"Sample text text content","html":"Sample html text content","sms":"example_sms","script":"Sample script text content"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Template"],"summary":"Update","description":"Update an existing Setup Template record by ID.","operationId":"setupTemplateUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupTemplateInput"},"example":{"account_id":1,"company_id":1,"app_id":1,"name":"Example Name","subject":"example_subject","text":"Sample text text content","html":"Sample html text content","sms":"example_sms","script":"Sample script text content"}}}}},"delete":{"tags":["Setup Template"],"summary":"Delete","description":"Delete a Setup Template record by ID.","operationId":"setupTemplateDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/transcription-classification-policy":{"get":{"tags":["Setup Transcription Classification Policy"],"summary":"List","description":"Retrieve a paginated list of Setup Transcription Classification Policy records. Supports filtering, sorting, and search.","operationId":"setupTranscriptionClassificationPolicyList","parameters":[{"in":"query","name":"action","description":"Filter by Action","required":false,"schema":{"type":"string","enum":["HANGUP","ALERT","TAG"]}},{"in":"query","name":"mode","description":"Filter by Mode","required":false,"schema":{"type":"string","enum":["shadow","active"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupTranscriptionClassificationPolicy"}},"example":[{"id":12345,"account_id":1,"company_id":1,"classifier_id":1,"name":"Example Name","description":"A detailed description of the resource","action":"HANGUP","tag":"example_tag","stage":"live","mode":"shadow","min_consecutive":1,"min_call_seconds":100,"enabled":true,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"},{"id":12345,"account_id":1,"company_id":1,"classifier_id":1,"name":"Example Name","description":"A detailed description of the resource","action":"HANGUP","tag":"example_tag","stage":"live","mode":"shadow","min_consecutive":1,"min_call_seconds":100,"enabled":true,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Transcription Classification Policy"],"summary":"Create","description":"Create a new Setup Transcription Classification Policy record.","operationId":"setupTranscriptionClassificationPolicyCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupTranscriptionClassificationPolicyInput"},"example":{"account_id":1,"company_id":1,"classifier_id":1,"name":"Example Name","description":"A detailed description of the resource","action":"HANGUP","tag":"example_tag","stage":"live","mode":"shadow","min_consecutive":1,"min_call_seconds":100,"enabled":true}}}}}},"/api/cp/setup/transcription-classification-policy-condition":{"get":{"tags":["Setup Transcription Classification Policy Condition"],"summary":"List","description":"Retrieve a paginated list of Setup Transcription Classification Policy Condition records. Supports filtering, sorting, and search.","operationId":"setupTranscriptionClassificationPolicyConditionList","parameters":[{"in":"query","name":"operator","description":"Filter by Operator","required":false,"schema":{"type":"string","enum":[">=","<="]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupTranscriptionClassificationPolicyCondition"}},"example":[{"id":12345,"policy_id":1,"classifier_id":1,"question_id":1,"operator":">=","threshold":99.99,"options":"Sample options text content","sort_order":100,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"},{"id":12345,"policy_id":1,"classifier_id":1,"question_id":1,"operator":">=","threshold":99.99,"options":"Sample options text content","sort_order":100,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Transcription Classification Policy Condition"],"summary":"Create","description":"Create a new Setup Transcription Classification Policy Condition record.","operationId":"setupTranscriptionClassificationPolicyConditionCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupTranscriptionClassificationPolicyConditionInput"},"example":{"policy_id":1,"classifier_id":1,"question_id":1,"operator":">=","threshold":99.99,"options":"Sample options text content","sort_order":100}}}}}},"/api/cp/setup/transcription-classification-policy-condition/{id}":{"get":{"tags":["Setup Transcription Classification Policy Condition"],"summary":"Read","description":"Retrieve a single Setup Transcription Classification Policy Condition record by ID.","operationId":"setupTranscriptionClassificationPolicyConditionRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupTranscriptionClassificationPolicyCondition"},"example":{"id":12345,"policy_id":1,"classifier_id":1,"question_id":1,"operator":">=","threshold":99.99,"options":"Sample options text content","sort_order":100,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Transcription Classification Policy Condition"],"summary":"Update","description":"Update an existing Setup Transcription Classification Policy Condition record by ID.","operationId":"setupTranscriptionClassificationPolicyConditionUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupTranscriptionClassificationPolicyConditionInput"},"example":{"policy_id":1,"classifier_id":1,"question_id":1,"operator":">=","threshold":99.99,"options":"Sample options text content","sort_order":100}}}}},"delete":{"tags":["Setup Transcription Classification Policy Condition"],"summary":"Delete","description":"Delete a Setup Transcription Classification Policy Condition record by ID.","operationId":"setupTranscriptionClassificationPolicyConditionDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/transcription-classification-policy/{id}":{"get":{"tags":["Setup Transcription Classification Policy"],"summary":"Read","description":"Retrieve a single Setup Transcription Classification Policy record by ID.","operationId":"setupTranscriptionClassificationPolicyRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupTranscriptionClassificationPolicy"},"example":{"id":12345,"account_id":1,"company_id":1,"classifier_id":1,"name":"Example Name","description":"A detailed description of the resource","action":"HANGUP","tag":"example_tag","stage":"live","mode":"shadow","min_consecutive":1,"min_call_seconds":100,"enabled":true,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Transcription Classification Policy"],"summary":"Update","description":"Update an existing Setup Transcription Classification Policy record by ID.","operationId":"setupTranscriptionClassificationPolicyUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupTranscriptionClassificationPolicyInput"},"example":{"account_id":1,"company_id":1,"classifier_id":1,"name":"Example Name","description":"A detailed description of the resource","action":"HANGUP","tag":"example_tag","stage":"live","mode":"shadow","min_consecutive":1,"min_call_seconds":100,"enabled":true}}}}},"delete":{"tags":["Setup Transcription Classification Policy"],"summary":"Delete","description":"Delete a Setup Transcription Classification Policy record by ID.","operationId":"setupTranscriptionClassificationPolicyDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/transcription-classifier":{"get":{"tags":["Setup Transcription Classifier"],"summary":"List","description":"Retrieve a paginated list of Setup Transcription Classifier records. Supports filtering, sorting, and search.","operationId":"setupTranscriptionClassifierList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupTranscriptionClassifier"}},"example":[{"id":12345,"account_id":1,"name":"Example Name","description":"A detailed description of the resource","context":"example_context","model":"example_model","live_enabled":true,"final_enabled":true,"min_first_words":100,"min_new_words":100,"min_interval_s":100,"final_idle_s":100,"fts_trigger":1,"revision":123,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"},{"id":12345,"account_id":1,"name":"Example Name","description":"A detailed description of the resource","context":"example_context","model":"example_model","live_enabled":true,"final_enabled":true,"min_first_words":100,"min_new_words":100,"min_interval_s":100,"final_idle_s":100,"fts_trigger":1,"revision":123,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Transcription Classifier"],"summary":"Create","description":"Create a new Setup Transcription Classifier record.","operationId":"setupTranscriptionClassifierCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupTranscriptionClassifierInput"},"example":{"account_id":1,"name":"Example Name","description":"A detailed description of the resource","context":"example_context","model":"example_model","live_enabled":true,"final_enabled":true,"min_first_words":100,"min_new_words":100,"min_interval_s":100,"final_idle_s":100,"fts_trigger":1,"revision":123}}}}}},"/api/cp/setup/transcription-classifier-assignment":{"get":{"tags":["Setup Transcription Classifier Assignment"],"summary":"List","description":"Retrieve a paginated list of Setup Transcription Classifier Assignment records. Supports filtering, sorting, and search.","operationId":"setupTranscriptionClassifierAssignmentList","parameters":[{"in":"query","name":"mode","description":"Filter by Mode","required":false,"schema":{"type":"string","enum":["shadow","active"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupTranscriptionClassifierAssignment"}},"example":[{"id":12345,"account_id":1,"company_id":1,"classifier_id":1,"mode":"shadow","enabled":true,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z","company_scope":123},{"id":12345,"account_id":1,"company_id":1,"classifier_id":1,"mode":"shadow","enabled":true,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z","company_scope":123}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Transcription Classifier Assignment"],"summary":"Create","description":"Create a new Setup Transcription Classifier Assignment record.","operationId":"setupTranscriptionClassifierAssignmentCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupTranscriptionClassifierAssignmentInput"},"example":{"account_id":1,"company_id":1,"classifier_id":1,"mode":"shadow","enabled":true,"company_scope":123}}}}}},"/api/cp/setup/transcription-classifier-assignment/{id}":{"get":{"tags":["Setup Transcription Classifier Assignment"],"summary":"Read","description":"Retrieve a single Setup Transcription Classifier Assignment record by ID.","operationId":"setupTranscriptionClassifierAssignmentRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupTranscriptionClassifierAssignment"},"example":{"id":12345,"account_id":1,"company_id":1,"classifier_id":1,"mode":"shadow","enabled":true,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z","company_scope":123}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Transcription Classifier Assignment"],"summary":"Update","description":"Update an existing Setup Transcription Classifier Assignment record by ID.","operationId":"setupTranscriptionClassifierAssignmentUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupTranscriptionClassifierAssignmentInput"},"example":{"account_id":1,"company_id":1,"classifier_id":1,"mode":"shadow","enabled":true,"company_scope":123}}}}},"delete":{"tags":["Setup Transcription Classifier Assignment"],"summary":"Delete","description":"Delete a Setup Transcription Classifier Assignment record by ID.","operationId":"setupTranscriptionClassifierAssignmentDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/transcription-classifier-question":{"get":{"tags":["Setup Transcription Classifier Question"],"summary":"List","description":"Retrieve a paginated list of Setup Transcription Classifier Question records. Supports filtering, sorting, and search.","operationId":"setupTranscriptionClassifierQuestionList","parameters":[{"in":"query","name":"type","description":"Filter by Type","required":false,"schema":{"type":"string","enum":["noul","choice","score"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupTranscriptionClassifierQuestion"}},"example":[{"id":12345,"classifier_id":1,"question_key":"example_question_key","label":"example_label","type":"noul","instructions":"example_instructions","criteria":"Sample criteria text content","sort_order":100,"enabled":true,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"},{"id":12345,"classifier_id":1,"question_key":"example_question_key","label":"example_label","type":"noul","instructions":"example_instructions","criteria":"Sample criteria text content","sort_order":100,"enabled":true,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Transcription Classifier Question"],"summary":"Create","description":"Create a new Setup Transcription Classifier Question record.","operationId":"setupTranscriptionClassifierQuestionCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupTranscriptionClassifierQuestionInput"},"example":{"classifier_id":1,"question_key":"example_question_key","label":"example_label","type":"noul","instructions":"example_instructions","criteria":"Sample criteria text content","sort_order":100,"enabled":true}}}}}},"/api/cp/setup/transcription-classifier-question/{id}":{"get":{"tags":["Setup Transcription Classifier Question"],"summary":"Read","description":"Retrieve a single Setup Transcription Classifier Question record by ID.","operationId":"setupTranscriptionClassifierQuestionRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupTranscriptionClassifierQuestion"},"example":{"id":12345,"classifier_id":1,"question_key":"example_question_key","label":"example_label","type":"noul","instructions":"example_instructions","criteria":"Sample criteria text content","sort_order":100,"enabled":true,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Transcription Classifier Question"],"summary":"Update","description":"Update an existing Setup Transcription Classifier Question record by ID.","operationId":"setupTranscriptionClassifierQuestionUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupTranscriptionClassifierQuestionInput"},"example":{"classifier_id":1,"question_key":"example_question_key","label":"example_label","type":"noul","instructions":"example_instructions","criteria":"Sample criteria text content","sort_order":100,"enabled":true}}}}},"delete":{"tags":["Setup Transcription Classifier Question"],"summary":"Delete","description":"Delete a Setup Transcription Classifier Question record by ID.","operationId":"setupTranscriptionClassifierQuestionDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/transcription-classifier/{id}":{"get":{"tags":["Setup Transcription Classifier"],"summary":"Read","description":"Retrieve a single Setup Transcription Classifier record by ID.","operationId":"setupTranscriptionClassifierRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupTranscriptionClassifier"},"example":{"id":12345,"account_id":1,"name":"Example Name","description":"A detailed description of the resource","context":"example_context","model":"example_model","live_enabled":true,"final_enabled":true,"min_first_words":100,"min_new_words":100,"min_interval_s":100,"final_idle_s":100,"fts_trigger":1,"revision":123,"created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Transcription Classifier"],"summary":"Update","description":"Update an existing Setup Transcription Classifier record by ID.","operationId":"setupTranscriptionClassifierUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupTranscriptionClassifierInput"},"example":{"account_id":1,"name":"Example Name","description":"A detailed description of the resource","context":"example_context","model":"example_model","live_enabled":true,"final_enabled":true,"min_first_words":100,"min_new_words":100,"min_interval_s":100,"final_idle_s":100,"fts_trigger":1,"revision":123}}}}},"delete":{"tags":["Setup Transcription Classifier"],"summary":"Delete","description":"Delete a Setup Transcription Classifier record by ID.","operationId":"setupTranscriptionClassifierDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/transcription-query-profile":{"get":{"tags":["Setup Transcription Query Profile"],"summary":"List","description":"Retrieve a paginated list of Setup Transcription Query Profile records. Supports filtering, sorting, and search.","operationId":"setupTranscriptionQueryProfileList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupTranscriptionQueryProfile"}},"example":[{"id character varying(255) NOT NULL\nname character varying(255)\naccount_id bigint\ncompany_id bigint\nquery text\nvisibility character varying(255)\naction":10},{"id character varying(255) NOT NULL\nname character varying(255)\naccount_id bigint\ncompany_id bigint\nquery text\nvisibility character varying(255)\naction":10}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Transcription Query Profile"],"summary":"Create","description":"Create a new Setup Transcription Query Profile record.","operationId":"setupTranscriptionQueryProfileCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupTranscriptionQueryProfileInput"},"example":{"id character varying(255) NOT NULL\nname character varying(255)\naccount_id bigint\ncompany_id bigint\nquery text\nvisibility character varying(255)\naction":10}}}}}},"/api/cp/setup/transcription-query-profile/{id}":{"get":{"tags":["Setup Transcription Query Profile"],"summary":"Read","description":"Retrieve a single Setup Transcription Query Profile record by ID.","operationId":"setupTranscriptionQueryProfileRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupTranscriptionQueryProfile"},"example":{"id character varying(255) NOT NULL\nname character varying(255)\naccount_id bigint\ncompany_id bigint\nquery text\nvisibility character varying(255)\naction":10}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Transcription Query Profile"],"summary":"Update","description":"Update an existing Setup Transcription Query Profile record by ID.","operationId":"setupTranscriptionQueryProfileUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupTranscriptionQueryProfileInput"},"example":{"id character varying(255) NOT NULL\nname character varying(255)\naccount_id bigint\ncompany_id bigint\nquery text\nvisibility character varying(255)\naction":10}}}}},"delete":{"tags":["Setup Transcription Query Profile"],"summary":"Delete","description":"Delete a Setup Transcription Query Profile record by ID.","operationId":"setupTranscriptionQueryProfileDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/url-endpoints":{"get":{"tags":["Setup Group Permission"],"summary":"URL Endpoints","description":"URL Endpoints","operationId":"setupGroupPermissionUrlEndpoints","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupGroupPermission"},"example":{"id":12345,"group_id":1,"path":"example_path","access":"get"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/usage/cdr":{"get":{"tags":["Setup Usage"],"summary":"CDR Usage","description":"CDR Usage","operationId":"setupUsageCdrUsage","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/usage/web":{"get":{"tags":["Setup Usage"],"summary":"Web Usage","description":"Web Usage","operationId":"setupUsageWebUsage","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/user":{"get":{"tags":["Setup User"],"summary":"List","description":"Retrieve a paginated list of Setup User records. Supports filtering, sorting, and search.","operationId":"setupUserList","parameters":[{"in":"query","name":"role","description":"Filter by Role","required":false,"schema":{"type":"string","enum":["Administrator","User","Guest"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupUser"}},"example":[{"id":12345,"account_id":1,"reseller_id":1,"name":"Example Name","email":"user@example.com","password":"********","mobile":"+1-555-123-4567","skype":"example_skype","role":"Administrator","tfa_secret":"example_tfa_secret","floating_noc":1,"language":"example_language","last_login":"2025-01-17T10:30:00Z","login_count":10,"mobile_verify":1000,"email_verify":123,"otp_hash":"example_otp_hash","api_key":"example_api_key","timezone":"example_timezone","readonly":1,"email_subscription":"example_email_subscription","ip_whitelist":"example_ip_whitelist","share_ticket":1,"id_verify":"example_id_verify","flags":"example_flags"},{"id":12345,"account_id":1,"reseller_id":1,"name":"Example Name","email":"user@example.com","password":"********","mobile":"+1-555-123-4567","skype":"example_skype","role":"Administrator","tfa_secret":"example_tfa_secret","floating_noc":1,"language":"example_language","last_login":"2025-01-17T10:30:00Z","login_count":10,"mobile_verify":1000,"email_verify":123,"otp_hash":"example_otp_hash","api_key":"example_api_key","timezone":"example_timezone","readonly":1,"email_subscription":"example_email_subscription","ip_whitelist":"example_ip_whitelist","share_ticket":1,"id_verify":"example_id_verify","flags":"example_flags"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup User"],"summary":"Create","description":"Create a new Setup User record.","operationId":"setupUserCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupUserInput"},"example":{"account_id":1,"reseller_id":1,"name":"Example Name","email":"user@example.com","password":"********","mobile":"+1-555-123-4567","skype":"example_skype","role":"Administrator","tfa_secret":"example_tfa_secret","floating_noc":1,"language":"example_language","last_login":"2025-01-17T10:30:00Z","login_count":10,"mobile_verify":1000,"email_verify":123,"otp_hash":"example_otp_hash","api_key":"example_api_key","timezone":"example_timezone","readonly":1,"email_subscription":"example_email_subscription","ip_whitelist":"example_ip_whitelist","share_ticket":1,"id_verify":"example_id_verify","flags":"example_flags"}}}}}},"/api/cp/setup/user/{id}":{"get":{"tags":["Setup User"],"summary":"Read","description":"Retrieve a single Setup User record by ID.","operationId":"setupUserRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupUser"},"example":{"id":12345,"account_id":1,"reseller_id":1,"name":"Example Name","email":"user@example.com","password":"********","mobile":"+1-555-123-4567","skype":"example_skype","role":"Administrator","tfa_secret":"example_tfa_secret","floating_noc":1,"language":"example_language","last_login":"2025-01-17T10:30:00Z","login_count":10,"mobile_verify":1000,"email_verify":123,"otp_hash":"example_otp_hash","api_key":"example_api_key","timezone":"example_timezone","readonly":1,"email_subscription":"example_email_subscription","ip_whitelist":"example_ip_whitelist","share_ticket":1,"id_verify":"example_id_verify","flags":"example_flags"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup User"],"summary":"Update","description":"Update an existing Setup User record by ID.","operationId":"setupUserUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupUserInput"},"example":{"account_id":1,"reseller_id":1,"name":"Example Name","email":"user@example.com","password":"********","mobile":"+1-555-123-4567","skype":"example_skype","role":"Administrator","tfa_secret":"example_tfa_secret","floating_noc":1,"language":"example_language","last_login":"2025-01-17T10:30:00Z","login_count":10,"mobile_verify":1000,"email_verify":123,"otp_hash":"example_otp_hash","api_key":"example_api_key","timezone":"example_timezone","readonly":1,"email_subscription":"example_email_subscription","ip_whitelist":"example_ip_whitelist","share_ticket":1,"id_verify":"example_id_verify","flags":"example_flags"}}}}},"delete":{"tags":["Setup User"],"summary":"Delete","description":"Delete a Setup User record by ID.","operationId":"setupUserDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/userspace/{area}":{"get":{"tags":["Setup Userspace"],"summary":"List","description":"Retrieve a paginated list of Setup Userspace records. Supports filtering, sorting, and search.","operationId":"setupUserspaceList","parameters":[{"in":"path","name":"area","description":"Area identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Userspace"],"summary":"Create","description":"Create a new Setup Userspace record.","operationId":"setupUserspaceCreate","parameters":[{"in":"path","name":"area","description":"Area identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/userspace/{area}/{id}":{"get":{"tags":["Setup Userspace"],"summary":"Read","description":"Retrieve a single Setup Userspace record by ID.","operationId":"setupUserspaceRead","parameters":[{"in":"path","name":"area","description":"Area identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Userspace"],"summary":"Update","description":"Update an existing Setup Userspace record by ID.","operationId":"setupUserspaceUpdate","parameters":[{"in":"path","name":"area","description":"Area identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"delete":{"tags":["Setup Userspace"],"summary":"Delete","description":"Delete a Setup Userspace record by ID.","operationId":"setupUserspaceDelete","parameters":[{"in":"path","name":"area","description":"Area identifier","required":true,"schema":{"type":"string"},"example":"example-value"},{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/var":{"get":{"tags":["Setup Vars"],"summary":"List","description":"Retrieve a paginated list of Setup Vars records. Supports filtering, sorting, and search.","operationId":"setupVarsList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupVars"}},"example":[{"id":12345,"account_id":1,"app_id":1,"key":"example_key","value":"Sample value text content","key_name":"example_key_name","last_update":"2025-01-17T10:30:00Z","flags":"protected"},{"id":12345,"account_id":1,"app_id":1,"key":"example_key","value":"Sample value text content","key_name":"example_key_name","last_update":"2025-01-17T10:30:00Z","flags":"protected"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Vars"],"summary":"Create","description":"Create a new Setup Vars record.","operationId":"setupVarsCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupVarsInput"},"example":{"account_id":1,"app_id":1,"key":"example_key","value":"Sample value text content","key_name":"example_key_name","last_update":"2025-01-17T10:30:00Z","flags":"protected"}}}}}},"/api/cp/setup/var/{id}":{"get":{"tags":["Setup Vars"],"summary":"Read","description":"Retrieve a single Setup Vars record by ID.","operationId":"setupVarsRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupVars"},"example":{"id":12345,"account_id":1,"app_id":1,"key":"example_key","value":"Sample value text content","key_name":"example_key_name","last_update":"2025-01-17T10:30:00Z","flags":"protected"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Vars"],"summary":"Update","description":"Update an existing Setup Vars record by ID.","operationId":"setupVarsUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupVarsInput"},"example":{"account_id":1,"app_id":1,"key":"example_key","value":"Sample value text content","key_name":"example_key_name","last_update":"2025-01-17T10:30:00Z","flags":"protected"}}}}},"delete":{"tags":["Setup Vars"],"summary":"Delete","description":"Delete a Setup Vars record by ID.","operationId":"setupVarsDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/voucher":{"get":{"tags":["Setup Voucher"],"summary":"List","description":"Retrieve a paginated list of Setup Voucher records. Supports filtering, sorting, and search.","operationId":"setupVoucherList","parameters":[{"in":"query","name":"state","description":"Filter by State","required":false,"schema":{"type":"string","enum":["Active","Inactive","Used"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupVoucher"}},"example":[{"id":12345,"code":"example_code","account_id":1,"end_date":"2025-01-17T10:30:00Z","state":"Active","description":"A detailed description of the resource","min_activation":99.99,"multiplier":99.99,"addition":99.99,"used_by_account_id":1,"use_once":1,"min_per_minute_rate":99.99},{"id":12345,"code":"example_code","account_id":1,"end_date":"2025-01-17T10:30:00Z","state":"Active","description":"A detailed description of the resource","min_activation":99.99,"multiplier":99.99,"addition":99.99,"used_by_account_id":1,"use_once":1,"min_per_minute_rate":99.99}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Voucher"],"summary":"Create","description":"Create a new Setup Voucher record.","operationId":"setupVoucherCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupVoucherInput"},"example":{"code":"example_code","account_id":1,"end_date":"2025-01-17T10:30:00Z","state":"Active","description":"A detailed description of the resource","min_activation":99.99,"multiplier":99.99,"addition":99.99,"used_by_account_id":1,"use_once":1,"min_per_minute_rate":99.99}}}}}},"/api/cp/setup/webphone":{"get":{"tags":["Setup Webphone"],"summary":"List","description":"Retrieve a paginated list of Setup Webphone records. Supports filtering, sorting, and search.","operationId":"setupWebphoneList","parameters":[{"in":"query","name":"deploy_type","description":"Filter by Deploy Type","required":false,"schema":{"type":"string","enum":["code","sms","existing"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/setupWebphone"}},"example":[{"id":12345,"account_id":1,"brand_name":"example_brand_name","domain":"example_domain","deploy_type":"code","signup_fields":"example_signup_fields","menu":"Sample menu text content","register_success_html":"Sample register_success_html text content","host":"example_host","flags":"BALANCE","netlify_site_id":1,"template_customer_id":1,"customers":"example_customers","css":"Sample css text content","codec_delete":"example_codec_delete","codec_priority":"example_codec_priority"},{"id":12345,"account_id":1,"brand_name":"example_brand_name","domain":"example_domain","deploy_type":"code","signup_fields":"example_signup_fields","menu":"Sample menu text content","register_success_html":"Sample register_success_html text content","host":"example_host","flags":"BALANCE","netlify_site_id":1,"template_customer_id":1,"customers":"example_customers","css":"Sample css text content","codec_delete":"example_codec_delete","codec_priority":"example_codec_priority"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Setup Webphone"],"summary":"Create","description":"Create a new Setup Webphone record.","operationId":"setupWebphoneCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupWebphoneInput"},"example":{"account_id":1,"brand_name":"example_brand_name","domain":"example_domain","deploy_type":"code","signup_fields":"example_signup_fields","menu":"Sample menu text content","register_success_html":"Sample register_success_html text content","host":"example_host","flags":"BALANCE","netlify_site_id":1,"template_customer_id":1,"customers":"example_customers","css":"Sample css text content","codec_delete":"example_codec_delete","codec_priority":"example_codec_priority"}}}}}},"/api/cp/setup/webphone/{id}":{"get":{"tags":["Setup Webphone"],"summary":"Read","description":"Retrieve a single Setup Webphone record by ID.","operationId":"setupWebphoneRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupWebphone"},"example":{"id":12345,"account_id":1,"brand_name":"example_brand_name","domain":"example_domain","deploy_type":"code","signup_fields":"example_signup_fields","menu":"Sample menu text content","register_success_html":"Sample register_success_html text content","host":"example_host","flags":"BALANCE","netlify_site_id":1,"template_customer_id":1,"customers":"example_customers","css":"Sample css text content","codec_delete":"example_codec_delete","codec_priority":"example_codec_priority"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Setup Webphone"],"summary":"Update","description":"Update an existing Setup Webphone record by ID.","operationId":"setupWebphoneUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupWebphoneInput"},"example":{"account_id":1,"brand_name":"example_brand_name","domain":"example_domain","deploy_type":"code","signup_fields":"example_signup_fields","menu":"Sample menu text content","register_success_html":"Sample register_success_html text content","host":"example_host","flags":"BALANCE","netlify_site_id":1,"template_customer_id":1,"customers":"example_customers","css":"Sample css text content","codec_delete":"example_codec_delete","codec_priority":"example_codec_priority"}}}}},"delete":{"tags":["Setup Webphone"],"summary":"Delete","description":"Delete a Setup Webphone record by ID.","operationId":"setupWebphoneDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/setup/webphone/{id}/check":{"get":{"tags":["Setup Webphone"],"summary":"Check","description":"Check","operationId":"setupWebphoneCheck","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setupWebphone"},"example":{"id":12345,"account_id":1,"brand_name":"example_brand_name","domain":"example_domain","deploy_type":"code","signup_fields":"example_signup_fields","menu":"Sample menu text content","register_success_html":"Sample register_success_html text content","host":"example_host","flags":"BALANCE","netlify_site_id":1,"template_customer_id":1,"customers":"example_customers","css":"Sample css text content","codec_delete":"example_codec_delete","codec_priority":"example_codec_priority"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/sip-device":{"get":{"tags":["Sip Device"],"summary":"List","description":"Retrieve a paginated list of Sip Device records. Supports filtering, sorting, and search.","operationId":"sipDeviceList","parameters":[{"in":"query","name":"status","description":"Filter by Status","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/sipDevice"}},"example":[{"id":12345,"uid":"example_uid","account_id":1,"company_id":1,"make":"example_make","model":"example_model","status":"Active","password":"********","admin_password":"example_admin_password","prov_uri":"example_prov_uri","firmware_uri":"example_firmware_uri","phonebook_uri":"example_phonebook_uri","activate_date":"2025-01-17T10:30:00Z","request_date":"2025-01-17T10:30:00Z","last_ip":"example_last_ip","retail":99.99,"package_id":1,"vars":"example_vars"},{"id":12345,"uid":"example_uid","account_id":1,"company_id":1,"make":"example_make","model":"example_model","status":"Active","password":"********","admin_password":"example_admin_password","prov_uri":"example_prov_uri","firmware_uri":"example_firmware_uri","phonebook_uri":"example_phonebook_uri","activate_date":"2025-01-17T10:30:00Z","request_date":"2025-01-17T10:30:00Z","last_ip":"example_last_ip","retail":99.99,"package_id":1,"vars":"example_vars"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Sip Device"],"summary":"Create","description":"Create a new Sip Device record.","operationId":"sipDeviceCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sipDeviceInput"},"example":{"uid":"example_uid","account_id":1,"company_id":1,"make":"example_make","model":"example_model","status":"Active","password":"********","admin_password":"example_admin_password","prov_uri":"example_prov_uri","firmware_uri":"example_firmware_uri","phonebook_uri":"example_phonebook_uri","activate_date":"2025-01-17T10:30:00Z","request_date":"2025-01-17T10:30:00Z","last_ip":"example_last_ip","retail":99.99,"package_id":1,"vars":"example_vars"}}}}}},"/api/cp/sip-device-line":{"get":{"tags":["Sip Device Line"],"summary":"List","description":"Retrieve a paginated list of Sip Device Line records. Supports filtering, sorting, and search.","operationId":"sipDeviceLineList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/sipDeviceLine"}},"example":[{"id":12345,"sip_device_id":1,"line_idx":1,"display_name":"example_display_name","cli":"example_cli","host":"example_host","username":"john_doe","password":"********","stun_server":"example_stun_server","proxy":"example_proxy","vars":"example_vars"},{"id":12345,"sip_device_id":1,"line_idx":1,"display_name":"example_display_name","cli":"example_cli","host":"example_host","username":"john_doe","password":"********","stun_server":"example_stun_server","proxy":"example_proxy","vars":"example_vars"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Sip Device Line"],"summary":"Create","description":"Create a new Sip Device Line record.","operationId":"sipDeviceLineCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sipDeviceLineInput"},"example":{"sip_device_id":1,"line_idx":1,"display_name":"example_display_name","cli":"example_cli","host":"example_host","username":"john_doe","password":"********","stun_server":"example_stun_server","proxy":"example_proxy","vars":"example_vars"}}}}}},"/api/cp/sip-device-line/{id}":{"get":{"tags":["Sip Device Line"],"summary":"Read","description":"Retrieve a single Sip Device Line record by ID.","operationId":"sipDeviceLineRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sipDeviceLine"},"example":{"id":12345,"sip_device_id":1,"line_idx":1,"display_name":"example_display_name","cli":"example_cli","host":"example_host","username":"john_doe","password":"********","stun_server":"example_stun_server","proxy":"example_proxy","vars":"example_vars"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Sip Device Line"],"summary":"Update","description":"Update an existing Sip Device Line record by ID.","operationId":"sipDeviceLineUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sipDeviceLineInput"},"example":{"sip_device_id":1,"line_idx":1,"display_name":"example_display_name","cli":"example_cli","host":"example_host","username":"john_doe","password":"********","stun_server":"example_stun_server","proxy":"example_proxy","vars":"example_vars"}}}}},"delete":{"tags":["Sip Device Line"],"summary":"Delete","description":"Delete a Sip Device Line record by ID.","operationId":"sipDeviceLineDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/sip-device/{id}":{"get":{"tags":["Sip Device"],"summary":"Read","description":"Retrieve a single Sip Device record by ID.","operationId":"sipDeviceRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sipDevice"},"example":{"id":12345,"uid":"example_uid","account_id":1,"company_id":1,"make":"example_make","model":"example_model","status":"Active","password":"********","admin_password":"example_admin_password","prov_uri":"example_prov_uri","firmware_uri":"example_firmware_uri","phonebook_uri":"example_phonebook_uri","activate_date":"2025-01-17T10:30:00Z","request_date":"2025-01-17T10:30:00Z","last_ip":"example_last_ip","retail":99.99,"package_id":1,"vars":"example_vars"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Sip Device"],"summary":"Update","description":"Update an existing Sip Device record by ID.","operationId":"sipDeviceUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sipDeviceInput"},"example":{"uid":"example_uid","account_id":1,"company_id":1,"make":"example_make","model":"example_model","status":"Active","password":"********","admin_password":"example_admin_password","prov_uri":"example_prov_uri","firmware_uri":"example_firmware_uri","phonebook_uri":"example_phonebook_uri","activate_date":"2025-01-17T10:30:00Z","request_date":"2025-01-17T10:30:00Z","last_ip":"example_last_ip","retail":99.99,"package_id":1,"vars":"example_vars"}}}}},"delete":{"tags":["Sip Device"],"summary":"Delete","description":"Delete a Sip Device record by ID.","operationId":"sipDeviceDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/sms-user":{"get":{"tags":["SMS User"],"summary":"List","description":"Retrieve a paginated list of SMS User records. Supports filtering, sorting, and search.","operationId":"smsUserList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/smsUser"}},"example":[{"id":12345,"company_id":1,"username":"john_doe","hash":"example_hash","protocol":"http"},{"id":12345,"company_id":1,"username":"john_doe","hash":"example_hash","protocol":"http"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["SMS User"],"summary":"Create","description":"Create a new SMS User record.","operationId":"smsUserCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/smsUserInput"},"example":{"company_id":1,"username":"john_doe","hash":"example_hash","protocol":"http"}}}}}},"/api/cp/sms-user/{id}":{"get":{"tags":["SMS User"],"summary":"Read","description":"Retrieve a single SMS User record by ID.","operationId":"smsUserRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/smsUser"},"example":{"id":12345,"company_id":1,"username":"john_doe","hash":"example_hash","protocol":"http"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["SMS User"],"summary":"Update","description":"Update an existing SMS User record by ID.","operationId":"smsUserUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/smsUserInput"},"example":{"company_id":1,"username":"john_doe","hash":"example_hash","protocol":"http"}}}}},"delete":{"tags":["SMS User"],"summary":"Delete","description":"Delete a SMS User record by ID.","operationId":"smsUserDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/socket":{"socket":{"tags":["Socket"],"summary":"Socket","description":"Socket","operationId":"socketSocket","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/status-component":{"get":{"tags":["Status Component"],"summary":"List","description":"Retrieve a paginated list of Status Component records. Supports filtering, sorting, and search.","operationId":"statusComponentList","parameters":[{"in":"query","name":"status","description":"Filter by Status","required":false,"schema":{"type":"string","enum":["operational","performance-issues","partial-outage","major-outage"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/statusComponent"}},"example":[{"id":12345,"account_id":1,"title":"Example Name","card_id":1,"description":"A detailed description of the resource","status":"operational"},{"id":12345,"account_id":1,"title":"Example Name","card_id":1,"description":"A detailed description of the resource","status":"operational"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Status Component"],"summary":"Create","description":"Create a new Status Component record.","operationId":"statusComponentCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/statusComponentInput"},"example":{"account_id":1,"title":"Example Name","card_id":1,"description":"A detailed description of the resource","status":"operational"}}}}}},"/api/cp/status-component/{id}":{"get":{"tags":["Status Component"],"summary":"Read","description":"Retrieve a single Status Component record by ID.","operationId":"statusComponentRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/statusComponent"},"example":{"id":12345,"account_id":1,"title":"Example Name","card_id":1,"description":"A detailed description of the resource","status":"operational"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Status Component"],"summary":"Update","description":"Update an existing Status Component record by ID.","operationId":"statusComponentUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/statusComponentInput"},"example":{"account_id":1,"title":"Example Name","card_id":1,"description":"A detailed description of the resource","status":"operational"}}}}},"delete":{"tags":["Status Component"],"summary":"Delete","description":"Delete a Status Component record by ID.","operationId":"statusComponentDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/status-incident":{"get":{"tags":["Status Incident"],"summary":"List","description":"Retrieve a paginated list of Status Incident records. Supports filtering, sorting, and search.","operationId":"statusIncidentList","parameters":[{"in":"query","name":"status","description":"Filter by Status","required":false,"schema":{"type":"string","enum":["fixed","watching","identified","investigating"]}},{"in":"query","name":"visibility","description":"Filter by Visibility","required":false,"schema":{"type":"string","enum":["public","private"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/statusIncident"}},"example":[{"id":12345,"account_id":1,"created":"2025-01-17T10:30:00Z","updated":"2025-01-17T10:30:00Z","title":"Example Name","description":"A detailed description of the resource","status":"fixed","visibility":"public"},{"id":12345,"account_id":1,"created":"2025-01-17T10:30:00Z","updated":"2025-01-17T10:30:00Z","title":"Example Name","description":"A detailed description of the resource","status":"fixed","visibility":"public"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Status Incident"],"summary":"Create","description":"Create a new Status Incident record.","operationId":"statusIncidentCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/statusIncidentInput"},"example":{"account_id":1,"created":"2025-01-17T10:30:00Z","updated":"2025-01-17T10:30:00Z","title":"Example Name","description":"A detailed description of the resource","status":"fixed","visibility":"public"}}}}}},"/api/cp/status-incident/{id}":{"get":{"tags":["Status Incident"],"summary":"Read","description":"Retrieve a single Status Incident record by ID.","operationId":"statusIncidentRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/statusIncident"},"example":{"id":12345,"account_id":1,"created":"2025-01-17T10:30:00Z","updated":"2025-01-17T10:30:00Z","title":"Example Name","description":"A detailed description of the resource","status":"fixed","visibility":"public"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Status Incident"],"summary":"Update","description":"Update an existing Status Incident record by ID.","operationId":"statusIncidentUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/statusIncidentInput"},"example":{"account_id":1,"created":"2025-01-17T10:30:00Z","updated":"2025-01-17T10:30:00Z","title":"Example Name","description":"A detailed description of the resource","status":"fixed","visibility":"public"}}}}},"delete":{"tags":["Status Incident"],"summary":"Delete","description":"Delete a Status Incident record by ID.","operationId":"statusIncidentDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/stream":{"get":{"tags":["Stream"],"summary":"List","description":"Retrieve a paginated list of Stream records. Supports filtering, sorting, and search.","operationId":"streamList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Stream"],"summary":"Create","description":"Create a new Stream record.","operationId":"streamCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/stream/{id}":{"get":{"tags":["Stream"],"summary":"Read","description":"Retrieve a single Stream record by ID.","operationId":"streamRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Stream"],"summary":"Update","description":"Update an existing Stream record by ID.","operationId":"streamUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"delete":{"tags":["Stream"],"summary":"Delete","description":"Delete a Stream record by ID.","operationId":"streamDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/support-ticket":{"get":{"tags":["Support Ticket"],"summary":"List","description":"Retrieve a paginated list of Support Ticket records. Supports filtering, sorting, and search.","operationId":"supportTicketList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/supportTicket"}},"example":[{"body":{},"createdBy":"example_createdBy","createdAt":"example_createdAt"},{"body":{},"createdBy":"example_createdBy","createdAt":"example_createdAt"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Support Ticket"],"summary":"Create","description":"Create a new Support Ticket record.","operationId":"supportTicketCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/support-ticket/{id}":{"get":{"tags":["Support Ticket"],"summary":"Read","description":"Retrieve a single Support Ticket record by ID.","operationId":"supportTicketRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/supportTicket"},"example":{"number":123,"type":123,"status":"Active","state":"example_state","subject":"example_subject","preview":"example_preview"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Support Ticket"],"summary":"Update","description":"Update an existing Support Ticket record by ID.","operationId":"supportTicketUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/switch/ip":{"get":{"tags":["Switch"],"summary":"List","description":"Retrieve a paginated list of Switch records. Supports filtering, sorting, and search.","operationId":"switchList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/switch"}},"example":[{"id":12345,"company_id":1,"ip":"192.168.1.1","proxy":"example_proxy","bandwidth":123,"channels":123,"cps":123,"manufacturer":"example_manufacturer","version":"example_version","protocol":"example_protocol","port":"example_port","codec":"example_codec","dial_pattern":"example_dial_pattern","prefix":"example_prefix","cli_prefix":"example_cli_prefix","strip":123,"cli_strip":123,"direction":"Ingress","user":"example_user","pass":"example_pass","from":"example_from","rewrite":"example_rewrite","force_nat":1,"intercept_reinvite":1,"flags":"example_flags","weight":1,"start_ip":123,"end_ip":123,"iso3166_alpha_2":"example_iso3166_alpha_2"},{"id":12345,"company_id":1,"ip":"192.168.1.1","proxy":"example_proxy","bandwidth":123,"channels":123,"cps":123,"manufacturer":"example_manufacturer","version":"example_version","protocol":"example_protocol","port":"example_port","codec":"example_codec","dial_pattern":"example_dial_pattern","prefix":"example_prefix","cli_prefix":"example_cli_prefix","strip":123,"cli_strip":123,"direction":"Ingress","user":"example_user","pass":"example_pass","from":"example_from","rewrite":"example_rewrite","force_nat":1,"intercept_reinvite":1,"flags":"example_flags","weight":1,"start_ip":123,"end_ip":123,"iso3166_alpha_2":"example_iso3166_alpha_2"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Switch"],"summary":"Create","description":"Create a new Switch record.","operationId":"switchCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/switchInput"},"example":{"company_id":1,"ip":"192.168.1.1","proxy":"example_proxy","bandwidth":123,"channels":123,"cps":123,"manufacturer":"example_manufacturer","version":"example_version","protocol":"example_protocol","port":"example_port","codec":"example_codec","dial_pattern":"example_dial_pattern","prefix":"example_prefix","cli_prefix":"example_cli_prefix","strip":123,"cli_strip":123,"direction":"Ingress","user":"example_user","pass":"example_pass","from":"example_from","rewrite":"example_rewrite","force_nat":1,"intercept_reinvite":1,"flags":"example_flags","weight":1,"start_ip":123,"end_ip":123,"iso3166_alpha_2":"example_iso3166_alpha_2"}}}}}},"/api/cp/switch/ip/status":{"get":{"tags":["Switch"],"summary":"Status","description":"Status","operationId":"switchStatus","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/switch"},"example":{"id":12345,"company_id":1,"ip":"192.168.1.1","proxy":"example_proxy","bandwidth":123,"channels":123,"cps":123,"manufacturer":"example_manufacturer","version":"example_version","protocol":"example_protocol","port":"example_port","codec":"example_codec","dial_pattern":"example_dial_pattern","prefix":"example_prefix","cli_prefix":"example_cli_prefix","strip":123,"cli_strip":123,"direction":"Ingress","user":"example_user","pass":"example_pass","from":"example_from","rewrite":"example_rewrite","force_nat":1,"intercept_reinvite":1,"flags":"example_flags","weight":1,"start_ip":123,"end_ip":123,"iso3166_alpha_2":"example_iso3166_alpha_2"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/switch/ip/{id}":{"get":{"tags":["Switch"],"summary":"Read","description":"Retrieve a single Switch record by ID.","operationId":"switchRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/switch"},"example":{"id":12345,"company_id":1,"ip":"192.168.1.1","proxy":"example_proxy","bandwidth":123,"channels":123,"cps":123,"manufacturer":"example_manufacturer","version":"example_version","protocol":"example_protocol","port":"example_port","codec":"example_codec","dial_pattern":"example_dial_pattern","prefix":"example_prefix","cli_prefix":"example_cli_prefix","strip":123,"cli_strip":123,"direction":"Ingress","user":"example_user","pass":"example_pass","from":"example_from","rewrite":"example_rewrite","force_nat":1,"intercept_reinvite":1,"flags":"example_flags","weight":1,"start_ip":123,"end_ip":123,"iso3166_alpha_2":"example_iso3166_alpha_2"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Switch"],"summary":"Update","description":"Update an existing Switch record by ID.","operationId":"switchUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/switchInput"},"example":{"company_id":1,"ip":"192.168.1.1","proxy":"example_proxy","bandwidth":123,"channels":123,"cps":123,"manufacturer":"example_manufacturer","version":"example_version","protocol":"example_protocol","port":"example_port","codec":"example_codec","dial_pattern":"example_dial_pattern","prefix":"example_prefix","cli_prefix":"example_cli_prefix","strip":123,"cli_strip":123,"direction":"Ingress","user":"example_user","pass":"example_pass","from":"example_from","rewrite":"example_rewrite","force_nat":1,"intercept_reinvite":1,"flags":"example_flags","weight":1,"start_ip":123,"end_ip":123,"iso3166_alpha_2":"example_iso3166_alpha_2"}}}}},"delete":{"tags":["Switch"],"summary":"Delete","description":"Delete a Switch record by ID.","operationId":"switchDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/switch/user":{"get":{"tags":["SIP User"],"summary":"List","description":"Retrieve a paginated list of SIP User records. Supports filtering, sorting, and search.","operationId":"sipUserList","parameters":[{"in":"query","name":"status","description":"Filter by Status","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/sipUser"}},"example":[{"id":12345,"company_id":1,"username":"john_doe","password":"********","bandwidth":123,"channels":123,"cps":123,"protocol":"example_protocol","codec":"example_codec","dial_pattern":"example_dial_pattern","prefix":"example_prefix","cli_prefix":"example_cli_prefix","strip":123,"status":"Active","rewrite":"example_rewrite","voicemail":1,"voicemail_password":"example_voicemail_password","ip_whitelist":"example_ip_whitelist","email":"user@example.com","sip_ping":1,"smart":1,"retain_did":1,"sip_profile_id":1,"address_number":"example_address_number","street_name":"example_street_name","city":"example_city","state":"example_state","post_code":"example_post_code"},{"id":12345,"company_id":1,"username":"john_doe","password":"********","bandwidth":123,"channels":123,"cps":123,"protocol":"example_protocol","codec":"example_codec","dial_pattern":"example_dial_pattern","prefix":"example_prefix","cli_prefix":"example_cli_prefix","strip":123,"status":"Active","rewrite":"example_rewrite","voicemail":1,"voicemail_password":"example_voicemail_password","ip_whitelist":"example_ip_whitelist","email":"user@example.com","sip_ping":1,"smart":1,"retain_did":1,"sip_profile_id":1,"address_number":"example_address_number","street_name":"example_street_name","city":"example_city","state":"example_state","post_code":"example_post_code"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["SIP User"],"summary":"Create","description":"Create a new SIP User record.","operationId":"sipUserCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sipUserInput"},"example":{"company_id":1,"username":"john_doe","password":"********","bandwidth":123,"channels":123,"cps":123,"protocol":"example_protocol","codec":"example_codec","dial_pattern":"example_dial_pattern","prefix":"example_prefix","cli_prefix":"example_cli_prefix","strip":123,"status":"Active","rewrite":"example_rewrite","voicemail":1,"voicemail_password":"example_voicemail_password","ip_whitelist":"example_ip_whitelist","email":"user@example.com","sip_ping":1,"smart":1,"retain_did":1,"sip_profile_id":1,"address_number":"example_address_number","street_name":"example_street_name","city":"example_city","state":"example_state","post_code":"example_post_code"}}}}}},"/api/cp/switch/user-ng911":{"get":{"tags":["SIP User ng911"],"summary":"List","description":"Retrieve a paginated list of SIP User ng911 records. Supports filtering, sorting, and search.","operationId":"sipUserNg911List","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/sipUserNg911"}},"example":[{"id":12345,"sip_user_id":1,"location_id":1,"location_name":"example_location_name","is_default":true,"country":"US","a1":"example_a1","a2":"example_a2","a3":"example_a3","a4":"example_a4","hno":"example_hno","hno_prefix":"example_hno_prefix","hno_suffix":"example_hno_suffix","prd":"example_prd","rd":"example_rd","sts":"example_sts","pod":"example_pod","prm":"example_prm","pom":"example_pom","bld":"example_bld","unit":"example_unit","flr":"example_flr","room":"example_room","seat":"example_seat","loc":"example_loc","nam":"example_nam","lmk":"example_lmk","plc":"example_plc","pc":"example_pc","pcn":"example_pcn","pobox":"example_pobox","addcode":"example_addcode","latitude":99.99,"longitude":99.99,"validated":1,"validated_at":"2025-01-17T10:30:00Z","validation_error":"example_validation_error","created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"},{"id":12345,"sip_user_id":1,"location_id":1,"location_name":"example_location_name","is_default":true,"country":"US","a1":"example_a1","a2":"example_a2","a3":"example_a3","a4":"example_a4","hno":"example_hno","hno_prefix":"example_hno_prefix","hno_suffix":"example_hno_suffix","prd":"example_prd","rd":"example_rd","sts":"example_sts","pod":"example_pod","prm":"example_prm","pom":"example_pom","bld":"example_bld","unit":"example_unit","flr":"example_flr","room":"example_room","seat":"example_seat","loc":"example_loc","nam":"example_nam","lmk":"example_lmk","plc":"example_plc","pc":"example_pc","pcn":"example_pcn","pobox":"example_pobox","addcode":"example_addcode","latitude":99.99,"longitude":99.99,"validated":1,"validated_at":"2025-01-17T10:30:00Z","validation_error":"example_validation_error","created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["SIP User ng911"],"summary":"Create","description":"Create a new SIP User ng911 record.","operationId":"sipUserNg911Create","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sipUserNg911Input"},"example":{"sip_user_id":1,"location_id":1,"location_name":"example_location_name","is_default":true,"country":"US","a1":"example_a1","a2":"example_a2","a3":"example_a3","a4":"example_a4","hno":"example_hno","hno_prefix":"example_hno_prefix","hno_suffix":"example_hno_suffix","prd":"example_prd","rd":"example_rd","sts":"example_sts","pod":"example_pod","prm":"example_prm","pom":"example_pom","bld":"example_bld","unit":"example_unit","flr":"example_flr","room":"example_room","seat":"example_seat","loc":"example_loc","nam":"example_nam","lmk":"example_lmk","plc":"example_plc","pc":"example_pc","pcn":"example_pcn","pobox":"example_pobox","addcode":"example_addcode","latitude":99.99,"longitude":99.99,"validated":1,"validated_at":"2025-01-17T10:30:00Z","validation_error":"example_validation_error"}}}}}},"/api/cp/switch/user-ng911/{id}":{"get":{"tags":["SIP User ng911"],"summary":"Read","description":"Retrieve a single SIP User ng911 record by ID.","operationId":"sipUserNg911Read","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sipUserNg911"},"example":{"id":12345,"sip_user_id":1,"location_id":1,"location_name":"example_location_name","is_default":true,"country":"US","a1":"example_a1","a2":"example_a2","a3":"example_a3","a4":"example_a4","hno":"example_hno","hno_prefix":"example_hno_prefix","hno_suffix":"example_hno_suffix","prd":"example_prd","rd":"example_rd","sts":"example_sts","pod":"example_pod","prm":"example_prm","pom":"example_pom","bld":"example_bld","unit":"example_unit","flr":"example_flr","room":"example_room","seat":"example_seat","loc":"example_loc","nam":"example_nam","lmk":"example_lmk","plc":"example_plc","pc":"example_pc","pcn":"example_pcn","pobox":"example_pobox","addcode":"example_addcode","latitude":99.99,"longitude":99.99,"validated":1,"validated_at":"2025-01-17T10:30:00Z","validation_error":"example_validation_error","created_at":"2025-01-17T10:30:00Z","updated_at":"2025-01-17T10:30:00Z"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["SIP User ng911"],"summary":"Update","description":"Update an existing SIP User ng911 record by ID.","operationId":"sipUserNg911Update","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sipUserNg911Input"},"example":{"sip_user_id":1,"location_id":1,"location_name":"example_location_name","is_default":true,"country":"US","a1":"example_a1","a2":"example_a2","a3":"example_a3","a4":"example_a4","hno":"example_hno","hno_prefix":"example_hno_prefix","hno_suffix":"example_hno_suffix","prd":"example_prd","rd":"example_rd","sts":"example_sts","pod":"example_pod","prm":"example_prm","pom":"example_pom","bld":"example_bld","unit":"example_unit","flr":"example_flr","room":"example_room","seat":"example_seat","loc":"example_loc","nam":"example_nam","lmk":"example_lmk","plc":"example_plc","pc":"example_pc","pcn":"example_pcn","pobox":"example_pobox","addcode":"example_addcode","latitude":99.99,"longitude":99.99,"validated":1,"validated_at":"2025-01-17T10:30:00Z","validation_error":"example_validation_error"}}}}},"delete":{"tags":["SIP User ng911"],"summary":"Delete","description":"Delete a SIP User ng911 record by ID.","operationId":"sipUserNg911Delete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/switch/user/{id}":{"get":{"tags":["SIP User"],"summary":"Read","description":"Retrieve a single SIP User record by ID.","operationId":"sipUserRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sipUser"},"example":{"id":12345,"company_id":1,"username":"john_doe","password":"********","bandwidth":123,"channels":123,"cps":123,"protocol":"example_protocol","codec":"example_codec","dial_pattern":"example_dial_pattern","prefix":"example_prefix","cli_prefix":"example_cli_prefix","strip":123,"status":"Active","rewrite":"example_rewrite","voicemail":1,"voicemail_password":"example_voicemail_password","ip_whitelist":"example_ip_whitelist","email":"user@example.com","sip_ping":1,"smart":1,"retain_did":1,"sip_profile_id":1,"address_number":"example_address_number","street_name":"example_street_name","city":"example_city","state":"example_state","post_code":"example_post_code"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["SIP User"],"summary":"Update","description":"Update an existing SIP User record by ID.","operationId":"sipUserUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sipUserInput"},"example":{"company_id":1,"username":"john_doe","password":"********","bandwidth":123,"channels":123,"cps":123,"protocol":"example_protocol","codec":"example_codec","dial_pattern":"example_dial_pattern","prefix":"example_prefix","cli_prefix":"example_cli_prefix","strip":123,"status":"Active","rewrite":"example_rewrite","voicemail":1,"voicemail_password":"example_voicemail_password","ip_whitelist":"example_ip_whitelist","email":"user@example.com","sip_ping":1,"smart":1,"retain_did":1,"sip_profile_id":1,"address_number":"example_address_number","street_name":"example_street_name","city":"example_city","state":"example_state","post_code":"example_post_code"}}}}},"delete":{"tags":["SIP User"],"summary":"Delete","description":"Delete a SIP User record by ID.","operationId":"sipUserDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/tag":{"get":{"tags":["Tag"],"summary":"List","description":"Retrieve a paginated list of Tag records. Supports filtering, sorting, and search.","operationId":"tagList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/tool/network-ping":{"post":{"tags":["Tool"],"summary":"Network Ping","description":"Network Ping","operationId":"toolNetworkPing","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/transcribe":{"get":{"tags":["Transcribe"],"summary":"List","description":"Retrieve a paginated list of Transcribe records. Supports filtering, sorting, and search.","operationId":"transcribeList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/transcribe"}},"example":[{"id uuid NOT NULL\ncallid character varying(255) NOT NULL\naccount_id integer\ncustomer_id integer\ntext text\nprovider_id integer\nleg character varying(255)\ndt timestamp without":10},{"id uuid NOT NULL\ncallid character varying(255) NOT NULL\naccount_id integer\ncustomer_id integer\ntext text\nprovider_id integer\nleg character varying(255)\ndt timestamp without":10}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/transcription":{"get":{"tags":["Transcription"],"summary":"List","description":"Retrieve a paginated list of Transcription records. Supports filtering, sorting, and search.","operationId":"transcriptionList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/transcription"}},"example":[{"callid character varying(255) NOT NULL\naccount_id integer\ncustomer_id integer\nfirst_dt timestamp without time zone\nlast_dt timestamp without time zone\nstart_time real\nend_time real\nchunk_count bigint NOT NULL\ntotal_chunk_duration double precision NOT NULL\ntotal_whisper_time double precision NOT NULL\ntotal_processing_time":10},{"callid character varying(255) NOT NULL\naccount_id integer\ncustomer_id integer\nfirst_dt timestamp without time zone\nlast_dt timestamp without time zone\nstart_time real\nend_time real\nchunk_count bigint NOT NULL\ntotal_chunk_duration double precision NOT NULL\ntotal_whisper_time double precision NOT NULL\ntotal_processing_time":10}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/transcription-report":{"get":{"tags":["Transcription Report"],"summary":"List","description":"Retrieve a paginated list of Transcription Report records. Supports filtering, sorting, and search.","operationId":"transcriptionReportList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/transcriptionReport"}},"example":[{"callid character varying(255)\naccount_id integer\ncustomer_id integer\nclassifier_id uuid\nclassifier_name character varying(128)\nfirst_chunk_at timestamp without time zone\nlast_chunk_at timestamp without time zone\ntranscript_duration_s real\nchunk_count integer\nwords_total integer\nlive_evaluations integer\npeak_scores jsonb\nfinal_status character varying(8)\nfinal_classification_id bigint\nfinal_completed_at timestamp without time zone\nfinal_model character varying(128)\nfinal_scores jsonb\nfts_matches bigint\nsemantic_matches bigint\nsemantic_actions ARRAY\ntags ARRAY\nfirst_semantic_match_offset_s real\nfirst_fts_match_offset_s real\nany_action_executed boolean\nexecuted_actions integer\nfailed_actions integer\npending_actions":10},{"callid character varying(255)\naccount_id integer\ncustomer_id integer\nclassifier_id uuid\nclassifier_name character varying(128)\nfirst_chunk_at timestamp without time zone\nlast_chunk_at timestamp without time zone\ntranscript_duration_s real\nchunk_count integer\nwords_total integer\nlive_evaluations integer\npeak_scores jsonb\nfinal_status character varying(8)\nfinal_classification_id bigint\nfinal_completed_at timestamp without time zone\nfinal_model character varying(128)\nfinal_scores jsonb\nfts_matches bigint\nsemantic_matches bigint\nsemantic_actions ARRAY\ntags ARRAY\nfirst_semantic_match_offset_s real\nfirst_fts_match_offset_s real\nany_action_executed boolean\nexecuted_actions integer\nfailed_actions integer\npending_actions":10}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/transcription-report/classification":{"get":{"tags":["Transcription Report"],"summary":"Classification List","description":"List semantic classification evaluations","operationId":"transcriptionReportClassificationList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/transcriptionReport"},"example":{"callid character varying(255)\naccount_id integer\ncustomer_id integer\nclassifier_id uuid\nclassifier_name character varying(128)\nfirst_chunk_at timestamp without time zone\nlast_chunk_at timestamp without time zone\ntranscript_duration_s real\nchunk_count integer\nwords_total integer\nlive_evaluations integer\npeak_scores jsonb\nfinal_status character varying(8)\nfinal_classification_id bigint\nfinal_completed_at timestamp without time zone\nfinal_model character varying(128)\nfinal_scores jsonb\nfts_matches bigint\nsemantic_matches bigint\nsemantic_actions ARRAY\ntags ARRAY\nfirst_semantic_match_offset_s real\nfirst_fts_match_offset_s real\nany_action_executed boolean\nexecuted_actions integer\nfailed_actions integer\npending_actions":10}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/transcription-report/classification/{id}":{"get":{"tags":["Transcription Report"],"summary":"Classification Read","description":"Read one semantic classification evaluation, including its transcript","operationId":"transcriptionReportClassificationRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/transcriptionReport"},"example":{"callid character varying(255)\naccount_id integer\ncustomer_id integer\nclassifier_id uuid\nclassifier_name character varying(128)\nfirst_chunk_at timestamp without time zone\nlast_chunk_at timestamp without time zone\ntranscript_duration_s real\nchunk_count integer\nwords_total integer\nlive_evaluations integer\npeak_scores jsonb\nfinal_status character varying(8)\nfinal_classification_id bigint\nfinal_completed_at timestamp without time zone\nfinal_model character varying(128)\nfinal_scores jsonb\nfts_matches bigint\nsemantic_matches bigint\nsemantic_actions ARRAY\ntags ARRAY\nfirst_semantic_match_offset_s real\nfirst_fts_match_offset_s real\nany_action_executed boolean\nexecuted_actions integer\nfailed_actions integer\npending_actions":10}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/transcription-report/classifier-snapshot":{"get":{"tags":["Transcription Report"],"summary":"Classifier Snapshot List","description":"List classifier configuration snapshots","operationId":"transcriptionReportClassifierSnapshotList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/transcriptionReport"},"example":{"callid character varying(255)\naccount_id integer\ncustomer_id integer\nclassifier_id uuid\nclassifier_name character varying(128)\nfirst_chunk_at timestamp without time zone\nlast_chunk_at timestamp without time zone\ntranscript_duration_s real\nchunk_count integer\nwords_total integer\nlive_evaluations integer\npeak_scores jsonb\nfinal_status character varying(8)\nfinal_classification_id bigint\nfinal_completed_at timestamp without time zone\nfinal_model character varying(128)\nfinal_scores jsonb\nfts_matches bigint\nsemantic_matches bigint\nsemantic_actions ARRAY\ntags ARRAY\nfirst_semantic_match_offset_s real\nfirst_fts_match_offset_s real\nany_action_executed boolean\nexecuted_actions integer\nfailed_actions integer\npending_actions":10}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/transcription-report/classifier-snapshot/{classifier_id}/{config_hash}":{"get":{"tags":["Transcription Report"],"summary":"Classifier Snapshot Read","description":"Read the classifier configuration a classification ran with","operationId":"transcriptionReportClassifierSnapshotRead","parameters":[{"in":"path","name":"classifier_id","description":"Classifier Id identifier","required":true,"schema":{"type":"integer"},"example":12345},{"in":"path","name":"config_hash","description":"Config Hash identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/transcriptionReport"},"example":{"callid character varying(255)\naccount_id integer\ncustomer_id integer\nclassifier_id uuid\nclassifier_name character varying(128)\nfirst_chunk_at timestamp without time zone\nlast_chunk_at timestamp without time zone\ntranscript_duration_s real\nchunk_count integer\nwords_total integer\nlive_evaluations integer\npeak_scores jsonb\nfinal_status character varying(8)\nfinal_classification_id bigint\nfinal_completed_at timestamp without time zone\nfinal_model character varying(128)\nfinal_scores jsonb\nfts_matches bigint\nsemantic_matches bigint\nsemantic_actions ARRAY\ntags ARRAY\nfirst_semantic_match_offset_s real\nfirst_fts_match_offset_s real\nany_action_executed boolean\nexecuted_actions integer\nfailed_actions integer\npending_actions":10}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/transcription-report/policy-decision":{"get":{"tags":["Transcription Report"],"summary":"Policy Decision List","description":"List policy decisions","operationId":"transcriptionReportPolicyDecisionList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/transcriptionReport"},"example":{"callid character varying(255)\naccount_id integer\ncustomer_id integer\nclassifier_id uuid\nclassifier_name character varying(128)\nfirst_chunk_at timestamp without time zone\nlast_chunk_at timestamp without time zone\ntranscript_duration_s real\nchunk_count integer\nwords_total integer\nlive_evaluations integer\npeak_scores jsonb\nfinal_status character varying(8)\nfinal_classification_id bigint\nfinal_completed_at timestamp without time zone\nfinal_model character varying(128)\nfinal_scores jsonb\nfts_matches bigint\nsemantic_matches bigint\nsemantic_actions ARRAY\ntags ARRAY\nfirst_semantic_match_offset_s real\nfirst_fts_match_offset_s real\nany_action_executed boolean\nexecuted_actions integer\nfailed_actions integer\npending_actions":10}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/transcription-report/policy-decision/{id}":{"get":{"tags":["Transcription Report"],"summary":"Policy Decision Read","description":"Read one policy decision","operationId":"transcriptionReportPolicyDecisionRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/transcriptionReport"},"example":{"callid character varying(255)\naccount_id integer\ncustomer_id integer\nclassifier_id uuid\nclassifier_name character varying(128)\nfirst_chunk_at timestamp without time zone\nlast_chunk_at timestamp without time zone\ntranscript_duration_s real\nchunk_count integer\nwords_total integer\nlive_evaluations integer\npeak_scores jsonb\nfinal_status character varying(8)\nfinal_classification_id bigint\nfinal_completed_at timestamp without time zone\nfinal_model character varying(128)\nfinal_scores jsonb\nfts_matches bigint\nsemantic_matches bigint\nsemantic_actions ARRAY\ntags ARRAY\nfirst_semantic_match_offset_s real\nfirst_fts_match_offset_s real\nany_action_executed boolean\nexecuted_actions integer\nfailed_actions integer\npending_actions":10}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/transcription-report/summary":{"get":{"tags":["Transcription Report"],"summary":"Summary","description":"Per-call aggregates of classification results over a time range","operationId":"transcriptionReportSummary","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/transcriptionReport"},"example":{"callid character varying(255)\naccount_id integer\ncustomer_id integer\nclassifier_id uuid\nclassifier_name character varying(128)\nfirst_chunk_at timestamp without time zone\nlast_chunk_at timestamp without time zone\ntranscript_duration_s real\nchunk_count integer\nwords_total integer\nlive_evaluations integer\npeak_scores jsonb\nfinal_status character varying(8)\nfinal_classification_id bigint\nfinal_completed_at timestamp without time zone\nfinal_model character varying(128)\nfinal_scores jsonb\nfts_matches bigint\nsemantic_matches bigint\nsemantic_actions ARRAY\ntags ARRAY\nfirst_semantic_match_offset_s real\nfirst_fts_match_offset_s real\nany_action_executed boolean\nexecuted_actions integer\nfailed_actions integer\npending_actions":10}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/transformation":{"get":{"tags":["Transformation"],"summary":"List","description":"Retrieve a paginated list of Transformation records. Supports filtering, sorting, and search.","operationId":"transformationList","parameters":[{"in":"query","name":"profit_type","description":"Filter by Profit Type","required":false,"schema":{"type":"string","enum":["absolute","relative","percent"]}},{"in":"query","name":"status","description":"Filter by Status","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/transformation"}},"example":[{"id":12345,"card_id":1,"prefix":"example_prefix","prefix_set_id":1,"profit_type":"absolute","cost":99.99,"percent":99.99,"edit_max_cost":99.99,"priority":1,"new_name":"example_new_name","mcd":1,"pulse":1,"cost_connect":99.99,"rounding":1,"apply_to":"example_apply_to","action":"example_action","status":"Active"},{"id":12345,"card_id":1,"prefix":"example_prefix","prefix_set_id":1,"profit_type":"absolute","cost":99.99,"percent":99.99,"edit_max_cost":99.99,"priority":1,"new_name":"example_new_name","mcd":1,"pulse":1,"cost_connect":99.99,"rounding":1,"apply_to":"example_apply_to","action":"example_action","status":"Active"}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Transformation"],"summary":"Create","description":"Create a new Transformation record.","operationId":"transformationCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/transformationInput"},"example":{"card_id":1,"prefix":"example_prefix","prefix_set_id":1,"profit_type":"absolute","cost":99.99,"percent":99.99,"edit_max_cost":99.99,"priority":1,"new_name":"example_new_name","mcd":1,"pulse":1,"cost_connect":99.99,"rounding":1,"apply_to":"example_apply_to","action":"example_action","status":"Active"}}}}}},"/api/cp/transformation/{id}":{"get":{"tags":["Transformation"],"summary":"Read","description":"Retrieve a single Transformation record by ID.","operationId":"transformationRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/transformation"},"example":{"id":12345,"card_id":1,"prefix":"example_prefix","prefix_set_id":1,"profit_type":"absolute","cost":99.99,"percent":99.99,"edit_max_cost":99.99,"priority":1,"new_name":"example_new_name","mcd":1,"pulse":1,"cost_connect":99.99,"rounding":1,"apply_to":"example_apply_to","action":"example_action","status":"Active"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Transformation"],"summary":"Update","description":"Update an existing Transformation record by ID.","operationId":"transformationUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/transformationInput"},"example":{"card_id":1,"prefix":"example_prefix","prefix_set_id":1,"profit_type":"absolute","cost":99.99,"percent":99.99,"edit_max_cost":99.99,"priority":1,"new_name":"example_new_name","mcd":1,"pulse":1,"cost_connect":99.99,"rounding":1,"apply_to":"example_apply_to","action":"example_action","status":"Active"}}}}},"delete":{"tags":["Transformation"],"summary":"Delete","description":"Delete a Transformation record by ID.","operationId":"transformationDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/tts":{"post":{"tags":["Tts"],"summary":"Save","description":"Save","operationId":"ttsSave","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/tts/test":{"get":{"tags":["Tts"],"summary":"Test","description":"Test","operationId":"ttsTest","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/tts/voices":{"get":{"tags":["Tts"],"summary":"Voices","description":"Voices","operationId":"ttsVoices","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/user-location":{"get":{"tags":["User Location"],"summary":"List","description":"Retrieve a paginated list of User Location records. Supports filtering, sorting, and search.","operationId":"userLocationList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/user-location/outbound":{"get":{"tags":["User Location"],"summary":"Outbound","description":"Outbound","operationId":"userLocationOutbound","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/user-location/registrar":{"get":{"tags":["User Location"],"summary":"Registrar","description":"Registrar","operationId":"userLocationRegistrar","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/voicemail":{"get":{"tags":["Voicemail"],"summary":"List","description":"Retrieve a paginated list of Voicemail records. Supports filtering, sorting, and search.","operationId":"voicemailList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/voicemail"}}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/voicemail/{id.wav}":{"get":{"tags":["Voicemail"],"summary":"Download","description":"Download","operationId":"voicemailDownload","parameters":[{"in":"path","name":"id.wav","description":"Id Wav identifier","required":true,"schema":{"type":"string"},"example":"example-value"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/voicemail"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/voicemail/{id}":{"delete":{"tags":["Voicemail"],"summary":"Delete","description":"Delete a Voicemail record by ID.","operationId":"voicemailDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/weylon":{"get":{"tags":["Weylon"],"summary":"List","description":"Retrieve a paginated list of Weylon records. Supports filtering, sorting, and search.","operationId":"weylonList","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/weylon"}},"example":[{"id":12345,"account_id":1,"company_id":1,"name":"Example Name","criteria":"Sample criteria text content","show_output":1},{"id":12345,"account_id":1,"company_id":1,"name":"Example Name","criteria":"Sample criteria text content","show_output":1}]}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"post":{"tags":["Weylon"],"summary":"Create","description":"Create a new Weylon record.","operationId":"weylonCreate","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"},"example":{"id":12345,"status":"OK"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/weylonInput"},"example":{"account_id":1,"company_id":1,"name":"Example Name","criteria":"Sample criteria text content","show_output":1}}}}}},"/api/cp/weylon/log/{id}":{"get":{"tags":["Weylon"],"summary":"Log","description":"Log","operationId":"weylonLog","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/weylon"},"example":{"id":12345,"account_id":1,"company_id":1,"name":"Example Name","criteria":"Sample criteria text content","show_output":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/weylon/tests":{"get":{"tags":["Weylon"],"summary":"Tests","description":"Tests","operationId":"weylonTests","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/weylon"},"example":{"id":12345,"account_id":1,"company_id":1,"name":"Example Name","criteria":"Sample criteria text content","show_output":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}},"/api/cp/weylon/{id}":{"get":{"tags":["Weylon"],"summary":"Read","description":"Retrieve a single Weylon record by ID.","operationId":"weylonRead","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/weylon"},"example":{"id":12345,"account_id":1,"company_id":1,"name":"Example Name","criteria":"Sample criteria text content","show_output":1}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]},"put":{"tags":["Weylon"],"summary":"Update","description":"Update an existing Weylon record by ID.","operationId":"weylonUpdate","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"409":{"description":"Conflict - foreign key or unique constraint violation on write","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintError"},"examples":{"foreignKey":{"summary":"Foreign key violation","value":{"error":"Foreign key constraint failed","message":"Referenced record does not exist","table":"company","column":"company_id","referencedTable":"company"}},"unique":{"summary":"Unique constraint violation","value":{"error":"Duplicate entry","message":"Value already exists","field":"email"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/weylonInput"},"example":{"account_id":1,"company_id":1,"name":"Example Name","criteria":"Sample criteria text content","show_output":1}}}}},"delete":{"tags":["Weylon"],"summary":"Delete","description":"Delete a Weylon record by ID.","operationId":"weylonDelete","parameters":[{"in":"path","name":"id","description":"Id identifier","required":true,"schema":{"type":"integer"},"example":12345}],"responses":{"200":{"description":"Operation completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request - Invalid parameters or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"validation":{"summary":"Validation error","value":{"error":"Validation failed","message":"Field \"name\" is required","field":"name"}},"constraint":{"summary":"Constraint violation","value":{"error":"Constraint violation","message":"Duplicate entry for unique field","field":"email","constraint":"unique"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Access denied - insufficient permissions or dependency access failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedError"},"examples":{"permission":{"summary":"Permission denied","value":{"error":"Access Denied","message":"Insufficient permissions for this operation"}},"dependency":{"summary":"Dependency access failure","value":{"error":"Access Denied","message":"Parent record not found or not accessible","table":"company","key":"company_id"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Not Found","message":"Record Not Found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"An unexpected error occurred"}}}}},"deprecated":false,"security":[{"oAuth2":[]},{"opaqueToken":[]}]}}}}