Files
replypier/e2e/src/api/schema.d.ts
T
WangShen007 54b949b392 chore(brand): rename the product to ReplyPier
The upstream project name is gone from code, assets, docs and build
output: brand strings, domains (replypier.site and its app/api/docs/help
subdomains), env prefixes, image and network names, the widget's public
JS API (window.ReplyPier, replypierId/BaseUrl/Config/Token), CSS tokens
(--rp-*), file and directory names, and the WordPress plugin package.

- widget loader is now webclient/replypier.min.js; both bundles rebuilt
  from source (backend/assets/widget.{js,css}, frontend/public/webclient)
- NOTICE, llms.txt, CONTRIBUTING, HELP_CENTER_INFRA and config.dev.js
  rewritten rather than string-swapped; the demo config no longer ships
  the previous vendor's Firebase/Razorpay/Google keys
- new migration replypier_ai_model_001 adds REPLYPIER to the managed
  AIModelType and rewrites pre-rename rows
- local compose project, database, role and volume renamed; LOCAL_DEPLOY
  documents carrying the old local data over
2026-10-26 00:51:03 +08:00

18325 lines
545 KiB
TypeScript

/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
"/api/v1/chats/": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Chat History */
get: operations["get_chat_history_api_v1_chats__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/chats/recent": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Recent Chats
* @description Get recent chats - supports both JWT and Shopify session token auth
*/
get: operations["get_recent_chats_api_v1_chats_recent_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/chats/recent/shopify": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Recent Chats
* @description Get recent chats - supports both JWT and Shopify session token auth
*/
get: operations["get_recent_chats_api_v1_chats_recent_shopify_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/chats/{session_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Chat Detail
* @description Get detailed chat history for a session - supports both JWT and Shopify session token auth
*/
get: operations["get_chat_detail_api_v1_chats__session_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/chats/{session_id}/shopify": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Chat Detail
* @description Get detailed chat history for a session - supports both JWT and Shopify session token auth
*/
get: operations["get_chat_detail_api_v1_chats__session_id__shopify_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/channels/accounts": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Channel Accounts
* @description All connected channel accounts for the organization.
*/
get: operations["list_channel_accounts_api_v1_channels_accounts_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/channels/telegram": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Connect Telegram
* @description Connect a Telegram bot: validate the token with getMe, store the
* encrypted credentials, and register our webhook with a secret token.
*/
post: operations["connect_telegram_api_v1_channels_telegram_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/channels/telegram/{account_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Disconnect Telegram
* @description Disconnect a Telegram bot: remove the webhook and delete the account.
*/
delete: operations["disconnect_telegram_api_v1_channels_telegram__account_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/channels/meta/embedded-signup-config": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Embedded Signup Config
* @description What the connect UI needs to decide between a Meta login flow and the
* manual credentials form, for the given channel. The app id is returned here
* rather than baked into the frontend build, so a self-hoster can point at
* their own app. A disabled channel returns no ids, so one channel's config
* never leaks on another's request.
*/
get: operations["get_embedded_signup_config_api_v1_channels_meta_embedded_signup_config_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/channels/meta/whatsapp": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Connect Whatsapp
* @description Connect a WhatsApp Cloud API number with manual credentials
* (phone_number_id + permanent token from the customer's own Meta app).
*/
post: operations["connect_whatsapp_api_v1_channels_meta_whatsapp_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/channels/meta/whatsapp/embedded-signup": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Connect Whatsapp Embedded Signup
* @description Finish an Embedded Signup flow: trade the code for the customer's
* business token and connect the number it created.
*
* Only the way the credentials are obtained differs from connect_whatsapp —
* everything after that is the same upsert and webhook subscribe.
*/
post: operations["connect_whatsapp_embedded_signup_api_v1_channels_meta_whatsapp_embedded_signup_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/channels/meta/messenger": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Connect Messenger
* @description Connect a Facebook Page for Messenger with a page access token.
*/
post: operations["connect_messenger_api_v1_channels_meta_messenger_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/channels/meta/messenger/signup/pages": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* List Messenger Signup Pages
* @description Step 1 of Facebook Login for Business: trade the code for the customer's
* Pages so they can pick which to connect.
*
* The Page tokens are sealed into signup_token and never reach the browser;
* only the ids and names come back for the picker.
*/
post: operations["list_messenger_signup_pages_api_v1_channels_meta_messenger_signup_pages_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/channels/meta/messenger/signup/connect": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Connect Messenger Signup
* @description Step 2: connect the Page the customer picked in step 1.
*
* page_id is a selector into the list we fetched ourselves, never a caller
* claim: the token stored is the one /me/accounts returned for that Page, so a
* caller cannot connect a Page they do not administer. This is the Messenger
* equivalent of _verify_signup_assets, and matters for the same reason —
* webhooks resolve accounts by external id with no org scoping.
*/
post: operations["connect_messenger_signup_api_v1_channels_meta_messenger_signup_connect_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/channels/meta/instagram/login/connect": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Connect Instagram Login
* @description Connect an Instagram professional account through Instagram Login.
*
* Unlike Messenger this needs no Facebook Page: the business signs in with
* Instagram itself, so the login returns exactly one account and there is
* nothing to pick. The token is an Instagram user token, used against
* graph.instagram.com rather than the Facebook graph.
*/
post: operations["connect_instagram_login_api_v1_channels_meta_instagram_login_connect_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/channels/meta/instagram": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Connect Instagram
* @description Connect an Instagram professional account (via its linked page token).
*/
post: operations["connect_instagram_api_v1_channels_meta_instagram_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/channels/meta/{account_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Disconnect Meta Account
* @description Disconnect a WhatsApp/Messenger/Instagram account.
*/
delete: operations["disconnect_meta_account_api_v1_channels_meta__account_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/channels/meta/whatsapp/{account_id}/conversations": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Start Whatsapp Conversation
* @description Start a WhatsApp conversation with a phone number via an approved
* Utility/Authentication template. The thin route: policy lives in the
* service so the Phase-2 scheduler can call the same function.
*/
post: operations["start_whatsapp_conversation_api_v1_channels_meta_whatsapp__account_id__conversations_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/channels/meta/whatsapp/{account_id}/send-template": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Send Whatsapp Template
* @description Send an approved template message to reopen an expired 24h window.
*/
post: operations["send_whatsapp_template_api_v1_channels_meta_whatsapp__account_id__send_template_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/channels/meta/whatsapp/{account_id}/templates": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Whatsapp Templates
* @description List the message templates on this number's WhatsApp Business Account.
*/
get: operations["list_whatsapp_templates_api_v1_channels_meta_whatsapp__account_id__templates_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/channels/meta/whatsapp/{account_id}/template-library": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Whatsapp Template Library
* @description Where to go to write a template: Meta's own Template Library, opened on
* this number's WhatsApp Business Account.
*
* Templates are not authored here. Meta's library holds ~150 pre-written,
* pre-localised utility templates plus its authentication ones, all shaped to
* pass its own review — a form of ours could only ever be a worse version of
* that, and every rule it encodes (categories, variable numbering, which
* buttons may be mixed) is Meta's to change without telling us.
*
* The link is built per account rather than hardcoded: business_id scopes the
* page to the right portfolio. It is best-effort — a business we cannot read
* gives a link that lands less precisely, not a dead button.
*/
get: operations["get_whatsapp_template_library_api_v1_channels_meta_whatsapp__account_id__template_library_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/channels/slack/install": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Install Slack
* @description Start the Slack OAuth install: redirect the browser to Slack's consent
* page with a CSRF state bound to the organization.
*/
get: operations["install_slack_api_v1_channels_slack_install_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/channels/slack/callback": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Slack Oauth Callback
* @description Complete the OAuth install: exchange the code, store the workspace as a
* channel account, and bounce back to the settings page.
*/
get: operations["slack_oauth_callback_api_v1_channels_slack_callback_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/channels/slack/{account_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/** Disconnect Slack */
delete: operations["disconnect_slack_api_v1_channels_slack__account_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/channels/email": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Connect Email
* @description Connect a support inbox. The response's webhook_url must be configured
* as the inbound-parse/forwarding target on the email provider. Outbound
* replies use the inbox's own SMTP when provided, else the platform SMTP.
*/
post: operations["connect_email_api_v1_channels_email_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/channels/email/{account_id}/webhook-url": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Email Webhook Url
* @description Re-show the inbound webhook URL for an existing email account.
*/
get: operations["get_email_webhook_url_api_v1_channels_email__account_id__webhook_url_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/channels/email/{account_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/** Disconnect Email */
delete: operations["disconnect_email_api_v1_channels_email__account_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/channels/sms/providers": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Sms Providers
* @description Available SMS providers and the credential fields each needs — drives
* the connect form's provider dropdown.
*/
get: operations["list_sms_providers_api_v1_channels_sms_providers_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/channels/sms": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Connect Sms
* @description Connect an SMS number through one of the supported providers. Validates
* the credentials with the provider before saving.
*/
post: operations["connect_sms_api_v1_channels_sms_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/channels/sms/{account_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/** Disconnect Sms */
delete: operations["disconnect_sms_api_v1_channels_sms__account_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/channels/line": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Connect Line
* @description Connect a LINE Official Account (channel secret + access token from the
* LINE Developers console). The webhook endpoint is set automatically.
*/
post: operations["connect_line_api_v1_channels_line_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/channels/line/{account_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/** Disconnect Line */
delete: operations["disconnect_line_api_v1_channels_line__account_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/channels/agent-config/{account_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Set Account Agent
* @description Route a connected channel account to an AI agent.
*/
post: operations["set_account_agent_api_v1_channels_agent_config__account_id__post"];
/**
* Clear Account Agent
* @description Stop routing a channel account to any agent (messages will be ignored).
*/
delete: operations["clear_account_agent_api_v1_channels_agent_config__account_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/tickets": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** List Tickets */
get: operations["list_tickets_api_v1_tickets_get"];
put?: never;
/** Create Ticket */
post: operations["create_ticket_api_v1_tickets_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/tickets/stats": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Ticket Stats */
get: operations["ticket_stats_api_v1_tickets_stats_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/tickets/settings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Settings */
get: operations["get_settings_api_v1_tickets_settings_get"];
/** Update Settings */
put: operations["update_settings_api_v1_tickets_settings_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/tickets/by-session/{session_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Ticket By Session */
get: operations["get_ticket_by_session_api_v1_tickets_by_session__session_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/tickets/draft-from-session/{session_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Draft From Session
* @description Non-LLM prefill for the create-ticket modal: title from the customer's
* last message, description from the recent transcript. AI triage rewrites
* the title after creation.
*/
get: operations["draft_from_session_api_v1_tickets_draft_from_session__session_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/tickets/{ticket_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Ticket */
get: operations["get_ticket_api_v1_tickets__ticket_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/** Update Ticket */
patch: operations["update_ticket_api_v1_tickets__ticket_id__patch"];
trace?: never;
};
"/api/v1/tickets/{ticket_id}/comments": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Add Comment */
post: operations["add_comment_api_v1_tickets__ticket_id__comments_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/tickets/{ticket_id}/resolve": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Resolve Ticket */
post: operations["resolve_ticket_api_v1_tickets__ticket_id__resolve_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/tickets/{ticket_id}/reopen": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Reopen Ticket */
post: operations["reopen_ticket_api_v1_tickets__ticket_id__reopen_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/tickets/{ticket_id}/investigate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Investigate Ticket
* @description Manually (re-)enqueue an AI run — a full investigation by default.
*/
post: operations["investigate_ticket_api_v1_tickets__ticket_id__investigate_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/tickets/{ticket_id}/investigation": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Investigation
* @description Glass-box payload: the latest (or requested) investigation run with its
* hypotheses, evidence events and the ticket's current RCA document.
*/
get: operations["get_investigation_api_v1_tickets__ticket_id__investigation_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/tickets/{ticket_id}/proposal/approve": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Approve Proposal
* @description Approve the pending AI-proposed resolution: the ticket resolves and
* the customer is notified with the proposal's message.
*/
post: operations["approve_proposal_api_v1_tickets__ticket_id__proposal_approve_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/tickets/{ticket_id}/proposal/reject": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Reject Proposal
* @description Reject the pending proposal; optionally re-run the investigation with
* the rejection reason as context.
*/
post: operations["reject_proposal_api_v1_tickets__ticket_id__proposal_reject_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/tickets/{ticket_id}/rca": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/**
* Update Rca
* @description Edit the RCA's customer summary and/or stamp the reviewer byline.
*/
patch: operations["update_rca_api_v1_tickets__ticket_id__rca_patch"];
trace?: never;
};
"/api/v1/tickets/{ticket_id}/rca/send-customer": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Send Rca To Customer
* @description Send the RCA's customer summary to the customer (a manual human action
* at autonomy L1/L2). Stamps the sender as reviewer.
*/
post: operations["send_rca_to_customer_api_v1_tickets__ticket_id__rca_send_customer_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/crm/connections": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Connections
* @description Connection status per provider for the integrations page, with a
* failed-push count so a quietly broken connection is visible.
*/
get: operations["list_connections_api_v1_crm_connections_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/crm/{provider}/install": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Install Crm
* @description Start the OAuth install: redirect the browser to the CRM's consent page
* with a CSRF state bound to (organization, provider).
*/
get: operations["install_crm_api_v1_crm__provider__install_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/crm/{provider}/callback": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Crm Oauth Callback
* @description Complete the OAuth install: exchange the code, upsert the connection,
* and bounce back to the settings page.
*/
get: operations["crm_oauth_callback_api_v1_crm__provider__callback_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/crm/{provider}/test": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Test Crm Connection
* @description Read-only connectivity check — never writes records into the CRM.
*/
post: operations["test_crm_connection_api_v1_crm__provider__test_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/crm/{provider}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Disconnect Crm
* @description Disconnect: best-effort token revocation, drop the row, cancel queued
* pushes. Agents' crm_sync_target stays set — it's simply inert until a
* reconnect, and the UI warns about the mismatch.
*/
delete: operations["disconnect_crm_api_v1_crm__provider__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/crm/hubspot/uninstall": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Hubspot Uninstall Webhook
* @description HubSpot app-uninstall events, authenticated by the v3 signature
* (HMAC-SHA256 over method+url+body+timestamp with the client secret).
*/
post: operations["hubspot_uninstall_webhook_api_v1_crm_hubspot_uninstall_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/crm/pipedrive/uninstall": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Pipedrive Uninstall Webhook
* @description Pipedrive app_uninstalled callback, authenticated with HTTP Basic —
* the Developer Hub webhook is configured with our client_id:client_secret.
*/
post: operations["pipedrive_uninstall_webhook_api_v1_crm_pipedrive_uninstall_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/ticket-db-connectors": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** List Connectors */
get: operations["list_connectors_api_v1_ticket_db_connectors_get"];
put?: never;
/** Create Connector */
post: operations["create_connector_api_v1_ticket_db_connectors_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/ticket-db-connectors/discover": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Discover Tables
* @description Pre-save connection test: connect with the given credentials and
* return the discoverable tables/columns for the allowlist picker.
*/
post: operations["discover_tables_api_v1_ticket_db_connectors_discover_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/ticket-db-connectors/{connector_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/** Delete Connector */
delete: operations["delete_connector_api_v1_ticket_db_connectors__connector_id__delete"];
options?: never;
head?: never;
/** Update Connector */
patch: operations["update_connector_api_v1_ticket_db_connectors__connector_id__patch"];
trace?: never;
};
"/api/v1/ticket-db-connectors/{connector_id}/test": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Test Saved Connector
* @description Test a saved connector with its stored credentials; refreshes the
* discoverable table list and records the outcome.
*/
post: operations["test_saved_connector_api_v1_ticket_db_connectors__connector_id__test_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/tickets/webhooks/alerts/{org_id}/{secret}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Alert Intake */
post: operations["alert_intake_api_v1_tickets_webhooks_alerts__org_id___secret__post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/webhooks/telegram/{account_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Telegram Webhook
* @description Receive a Telegram Bot API update. Verifies the per-account secret
* token, acks immediately, and processes the message in the background.
*/
post: operations["telegram_webhook_api_v1_webhooks_telegram__account_id__post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/webhooks/slack": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Slack Webhook
* @description Slack Events API endpoint: URL verification handshake plus @mention and
* DM events, verified against the app signing secret, acked immediately and
* processed in the background.
*/
post: operations["slack_webhook_api_v1_webhooks_slack_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/webhooks/email/{account_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Email Webhook
* @description Inbound-parse webhook (point SendGrid/Brevo/your forwarder here with
* the account's ?token=). Accepts JSON or multipart/urlencoded form.
*/
post: operations["email_webhook_api_v1_webhooks_email__account_id__post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/webhooks/sms/{provider}/{account_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Sms Webhook
* @description Inbound SMS for any provider. The provider in the path selects the
* parser/verifier; it must match the account's configured provider.
*/
post: operations["sms_webhook_api_v1_webhooks_sms__provider___account_id__post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/webhooks/line/{account_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Line Webhook
* @description LINE Messaging API webhook, verified via X-Line-Signature.
*/
post: operations["line_webhook_api_v1_webhooks_line__account_id__post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/webhooks/meta": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Meta Webhook Verify
* @description Webhook verification handshake (App Dashboard → Webhooks → Verify).
*/
get: operations["meta_webhook_verify_api_v1_webhooks_meta_get"];
put?: never;
/**
* Meta Webhook
* @description Receive a Meta webhook for any of WhatsApp / Messenger / Instagram.
*
* Verifies the app-level signature, routes on the `object` field, resolves
* the connected account per message, acks immediately, and processes in the
* background.
*/
post: operations["meta_webhook_api_v1_webhooks_meta_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/webhooks/meta/{account_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Own App Webhook Verify
* @description Verification handshake for an account connected from the customer's
* own Meta app: its verify token is the account's webhook secret.
*/
get: operations["own_app_webhook_verify_api_v1_webhooks_meta__account_id__get"];
put?: never;
/**
* Own App Webhook
* @description A webhook for an account connected from the customer's own Meta app.
*
* Checked with that app's secret only, and only taken for this
* organization's accounts from the same app: the secret is one the customer
* chose, so it must never vouch for anyone else's.
*/
post: operations["own_app_webhook_api_v1_webhooks_meta__account_id__post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/organizations": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create Organization
* @description Create a new organization with an admin user and default roles
*/
post: operations["create_organization_api_v1_organizations_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/organizations/setup-status": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Is Organization Setup
* @description Check if at least one active organization is set up.
*/
get: operations["is_organization_setup_api_v1_organizations_setup_status_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/organizations/check-domain/{domain}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Check Domain Availability
* @description Check if an organization domain is available
*/
get: operations["check_domain_availability_api_v1_organizations_check_domain__domain__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/organizations/{org_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Organization
* @description Get organization by ID
*/
get: operations["get_organization_api_v1_organizations__org_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/**
* Update Organization
* @description Update organization details including business hours
*/
patch: operations["update_organization_api_v1_organizations__org_id__patch"];
trace?: never;
};
"/api/v1/organizations/{org_id}/stats": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Organization Stats
* @description Get organization statistics
*/
get: operations["get_organization_stats_api_v1_organizations__org_id__stats_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/users": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Users
* @description List all users in the organization
*/
get: operations["list_users_api_v1_users_get"];
put?: never;
/**
* Create User
* @description Create a new user
*/
post: operations["create_user_api_v1_users_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/users/team-overview": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Team Overview
* @description Aggregated Human-Agents dashboard: per-agent load/resolved counts + org KPIs.
*/
get: operations["get_team_overview_api_v1_users_team_overview_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/users/teammates": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Teammates
* @description The colleagues an inbox user can hand a conversation to.
*
* Declared above GET /{user_id}: below it, "teammates" parses as a user id
* and the request lands on the manage_users route — a 403 for exactly the
* agents this exists for.
*
* Deliberately not a relaxation of GET /users, which returns each teammate's
* role and its full permission list. Reassigning a chat needs a name and a
* face, so that is all this returns.
*/
get: operations["list_teammates_api_v1_users_teammates_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/users/me/avatar": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get My Avatar
* @description Redirect to the caller's profile picture, signed at request time.
*
* The dashboard used to render the URL held in the cached `user_info` blob.
* That blob is written at login and never rewritten, but the URL inside it is
* an S3 presigned link good for S3_PRESIGN_EXPIRY_SECONDS — an hour by
* default. Every session outlasted its own avatar, and the only way to get a
* working one back was to log out and in again.
*
* A stable path fixes that for good: the browser asks us, and whatever it
* gets handed is freshly signed. no-store because the *redirect* must not be
* cached — the object it points at still can be.
*
* Declared above GET /{user_id}, or "me" parses as a user id.
*/
get: operations["get_my_avatar_api_v1_users_me_avatar_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/users/{user_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get User
* @description Get user by ID
*/
get: operations["get_user_api_v1_users__user_id__get"];
/**
* Update User
* @description Update a user
*/
put: operations["update_user_api_v1_users__user_id__put"];
post?: never;
/**
* Delete User
* @description Delete a user
*/
delete: operations["delete_user_api_v1_users__user_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/users/login": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Login
* @description Authenticate user and set cookies
*/
post: operations["login_api_v1_users_login_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/users/refresh": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Refresh Token
* @description Get new access token using refresh token from cookie
*/
post: operations["refresh_token_api_v1_users_refresh_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/users/logout": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Logout
* @description Logout user, end the session and clear cookies
*/
post: operations["logout_api_v1_users_logout_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/users/token/fcm-token": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Register Fcm Token
* @description Register this browser's web-push token for the signed-in user.
*/
post: operations["register_fcm_token_api_v1_users_token_fcm_token_post"];
/**
* Unregister Fcm Token
* @description Drop this browser's token on logout.
*
* The token is required: clearing every token for the account (what this used
* to do) meant signing out on a laptop silently killed push on the user's
* phone. A device that can no longer produce its token is cleaned up instead
* by the dead-token pruning in send_fcm_notification.
*/
delete: operations["unregister_fcm_token_api_v1_users_token_fcm_token_delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/users/me": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/**
* Update Profile
* @description Update current user's profile
*/
patch: operations["update_profile_api_v1_users_me_patch"];
trace?: never;
};
"/api/v1/users/{user_id}/reset-password": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Reset User Password
* @description Set a new password for another user in the caller's organization.
*
* For the common case of an agent locked out of their account: the admin sets
* a password and hands it over, rather than the agent going through the
* email OTP flow (which the community edition does not ship).
*/
post: operations["reset_user_password_api_v1_users__user_id__reset_password_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/users/{user_id}/status": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Update User Status
* @description Update user's online status
*/
post: operations["update_user_status_api_v1_users__user_id__status_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/users/me/profile-pic": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Upload Profile Pic
* @description Upload user profile picture
*/
post: operations["upload_profile_pic_api_v1_users_me_profile_pic_post"];
/**
* Delete Profile Pic
* @description Delete user profile picture
*/
delete: operations["delete_profile_pic_api_v1_users_me_profile_pic_delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/help-center/settings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Settings
* @description Get-or-create the org's help center settings. Ungated read: the response
* carries plan_allowed so the UI can render the upgrade lock.
*/
get: operations["get_settings_api_v1_help_center_settings_get"];
/** Update Settings */
put: operations["update_settings_api_v1_help_center_settings_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/help-center/logo": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Upload Logo */
post: operations["upload_logo_api_v1_help_center_logo_post"];
/** Remove Logo */
delete: operations["remove_logo_api_v1_help_center_logo_delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/help-center/favicon": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Upload Favicon */
post: operations["upload_favicon_api_v1_help_center_favicon_post"];
/** Remove Favicon */
delete: operations["remove_favicon_api_v1_help_center_favicon_delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/help-center/faqs": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** List Faqs */
get: operations["list_faqs_api_v1_help_center_faqs_get"];
put?: never;
/** Create Faq */
post: operations["create_faq_api_v1_help_center_faqs_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/help-center/faqs/categories": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** List Categories */
get: operations["list_categories_api_v1_help_center_faqs_categories_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/help-center/faqs/image": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Upload Faq Image
* @description Upload an image for embedding in an article's Markdown. Returns a stable
* absolute URL the editor inserts as ![](url).
*/
post: operations["upload_faq_image_api_v1_help_center_faqs_image_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/help-center/faqs/{faq_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Update Faq */
put: operations["update_faq_api_v1_help_center_faqs__faq_id__put"];
post?: never;
/** Delete Faq */
delete: operations["delete_faq_api_v1_help_center_faqs__faq_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/help-center/faqs/bulk-status": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Bulk Set Status
* @description Publish/unpublish one or many FAQs in a single call.
*/
post: operations["bulk_set_status_api_v1_help_center_faqs_bulk_status_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/help-center/faqs/bulk-delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Bulk Delete
* @description Delete many FAQs in one call (org-scoped; foreign ids are ignored).
*/
post: operations["bulk_delete_api_v1_help_center_faqs_bulk_delete_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/help-center/generate/estimate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Generation Estimate
* @description Pre-generation numbers for the confirm dialog: new (ungenerated)
* sources, page count, estimated LLM calls and remaining credits.
*/
get: operations["generation_estimate_api_v1_help_center_generate_estimate_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/help-center/generate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Start Generation
* @description Draft FAQs from the knowledge base (additive; the worker dedups against
* existing questions). By default only sources without FAQs are read;
* knowledge_ids explicitly targets sources instead.
*/
post: operations["start_generation_api_v1_help_center_generate_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/help-center/import": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Start Import
* @description Migrate an existing help center. mode=qa extracts Q&A pairs from the
* page with the org's model (uses credits); mode=articles crawls the page's
* linked article pages and imports each one as-is (Markdown, no LLM).
*/
post: operations["start_import_api_v1_help_center_import_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/help-center/import/pdf": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Start Pdf Import
* @description Extract Q&A pairs from an uploaded PDF with the org's model. The file
* is persisted via shared storage (the worker runs in another container)
* and deleted after processing.
*/
post: operations["start_pdf_import_api_v1_help_center_import_pdf_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/help-center/jobs": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Job
* @description The UI's polling endpoint: the running job if any (active=true), or the
* most recent job of any status (active=false) for showing the last outcome.
*/
get: operations["get_job_api_v1_help_center_jobs_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/help-center/jobs/{job_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Job By Id */
get: operations["get_job_by_id_api_v1_help_center_jobs__job_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/help-center/domain": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Set Domain */
post: operations["set_domain_api_v1_help_center_domain_post"];
/** Remove Domain */
delete: operations["remove_domain_api_v1_help_center_domain_delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/help-center/domain/verify": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Verify Domain */
post: operations["verify_domain_api_v1_help_center_domain_verify_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/help-center/domain/status": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Domain Status
* @description Stored state only — cheap enough for the UI's pending-domain polling.
* POST /domain/verify is the endpoint that re-runs live DNS checks.
*/
get: operations["domain_status_api_v1_help_center_domain_status_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/knowledge/upload/pdf": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Upload Pdf Files
* @description Upload PDF files to knowledge base
*/
post: operations["upload_pdf_files_api_v1_knowledge_upload_pdf_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/knowledge/explore/progress/{queue_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Explore Progress
* @description Get progress status for knowledge base processing
*/
get: operations["get_explore_progress_api_v1_knowledge_explore_progress__queue_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/knowledge/add/urls": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Add Urls
* @description Add URLs to knowledge base
*/
post: operations["add_urls_api_v1_knowledge_add_urls_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/knowledge/add/text": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Add Text Source
* @description Create a knowledge source from pasted text and index it immediately.
*/
post: operations["add_text_source_api_v1_knowledge_add_text_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/knowledge/link": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Link Knowledge To Agent
* @description Link existing knowledge to an agent
*/
post: operations["link_knowledge_to_agent_api_v1_knowledge_link_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/knowledge/unlink": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Unlink Knowledge From Agent
* @description Unlink knowledge from an agent
*/
delete: operations["unlink_knowledge_from_agent_api_v1_knowledge_unlink_delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/knowledge/agent/{agent_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Knowledge By Agent
* @description Get knowledge sources and their data for an agent with pagination
*/
get: operations["get_knowledge_by_agent_api_v1_knowledge_agent__agent_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/knowledge/queue/agent/{agent_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Agent Queue Items
* @description Get all queue items (pending, processing, failed) for an agent
*/
get: operations["get_agent_queue_items_api_v1_knowledge_queue_agent__agent_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/knowledge/queue/organization/{org_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Organization Queue Items
* @description Get all in-flight queue items (pending, processing, failed) for an org.
*/
get: operations["get_organization_queue_items_api_v1_knowledge_queue_organization__org_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/knowledge/queue/{queue_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Queue Status
* @description Get status of a queued knowledge item
*/
get: operations["get_queue_status_api_v1_knowledge_queue__queue_id__get"];
put?: never;
post?: never;
/**
* Delete Queue Item
* @description Delete a queue item (only if failed or pending)
*/
delete: operations["delete_queue_item_api_v1_knowledge_queue__queue_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/knowledge/organization/{org_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Knowledge By Organization
* @description Get knowledge sources and their data for an organization with pagination
*/
get: operations["get_knowledge_by_organization_api_v1_knowledge_organization__org_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/knowledge/processor/status": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Processor Status
* @description Get status of the knowledge processor for user's organization
*/
get: operations["get_processor_status_api_v1_knowledge_processor_status_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/knowledge/{knowledge_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Delete Knowledge
* @description Delete a knowledge source and its associated data
*/
delete: operations["delete_knowledge_api_v1_knowledge__knowledge_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/knowledge/{knowledge_id}/content": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Knowledge Content
* @description Get knowledge content chunks from vector database
*/
get: operations["get_knowledge_content_api_v1_knowledge__knowledge_id__content_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/knowledge/{knowledge_id}/chunk/{chunk_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* Update Chunk Content
* @description Update a single chunk's content in vector database
*/
put: operations["update_chunk_content_api_v1_knowledge__knowledge_id__chunk__chunk_id__put"];
post?: never;
/**
* Delete Chunk
* @description Delete a single chunk from vector database
*/
delete: operations["delete_chunk_api_v1_knowledge__knowledge_id__chunk__chunk_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/knowledge/{knowledge_id}/subpage": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Add Subpage
* @description Add a new subpage to existing knowledge
*/
post: operations["add_subpage_api_v1_knowledge__knowledge_id__subpage_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/knowledge/{knowledge_id}/page/{page_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* Update Page Content
* @description Replace a sub-page's content and re-embed it.
*
* A page may span several ``_N`` chunks; this collapses it into one freshly
* embedded chunk keyed by the page id, keeping the source's answers current.
*/
put: operations["update_page_content_api_v1_knowledge__knowledge_id__page__page_id__put"];
post?: never;
/**
* Delete Page
* @description Delete a whole sub-page (all of its chunks) from a knowledge source.
*/
delete: operations["delete_page_api_v1_knowledge__knowledge_id__page__page_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/ai/providers": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Providers
* @description Return the catalog of selectable providers and their suggested models.
*/
get: operations["get_providers_api_v1_ai_providers_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/ai/setup": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Setup Ai
* @description Setup AI configuration for the current user's organization
*/
post: operations["setup_ai_api_v1_ai_setup_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/ai/config": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Organization Ai Config
* @description Get active AI configuration for the current user's organization
*/
get: operations["get_organization_ai_config_api_v1_ai_config_get"];
/**
* Update Ai Config
* @description Update AI configuration for the current user's organization
*/
put: operations["update_ai_config_api_v1_ai_config_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/agent": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create Agent
* @description Create a new agent
*/
post: operations["create_agent_api_v1_agent_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/agent/{agent_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Agent By Id
* @description Get agent by ID with customization - supports both JWT and Shopify session token auth
*/
get: operations["get_agent_by_id_api_v1_agent__agent_id__get"];
/**
* Update Agent
* @description Update agent details - supports both JWT and Shopify session token auth
*/
put: operations["update_agent_api_v1_agent__agent_id__put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/agent/{agent_id}/shopify": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Agent By Id
* @description Get agent by ID with customization - supports both JWT and Shopify session token auth
*/
get: operations["get_agent_by_id_api_v1_agent__agent_id__shopify_get"];
/**
* Update Agent
* @description Update agent details - supports both JWT and Shopify session token auth
*/
put: operations["update_agent_api_v1_agent__agent_id__shopify_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/agent/roster": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Agent Roster
* @description Names of the org's AI agents, for the inbox filter.
*
* Declared above GET /{agent_id}, which takes a UUID — below it, "roster"
* fails UUID parsing and 422s.
*
* Deliberately not GET /agent/list: AgentResponse carries `instructions` and
* `guardrail_prompt`, and the guardrail prompt tells a reader exactly how to
* phrase a bypass. Filtering conversations needs a name.
*/
get: operations["get_agent_roster_api_v1_agent_roster_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/agent/guardrail-default": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Guardrail Default
* @description The shipped scope rule, with {org} already filled in.
*
* The dashboard shows this as the starting text so operators can read and edit
* the actual rule instead of a prose summary of it — which drifted from the real
* wording the first time the default changed. Served from the backend rather
* than duplicated in the frontend so there is one source of truth.
*
* Declared before /{agent_id} so the literal path wins the route match.
*/
get: operations["get_guardrail_default_api_v1_agent_guardrail_default_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/agent/list": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Organization Agents
* @description Get organization agents - supports both JWT and Shopify session token auth
*/
get: operations["get_organization_agents_api_v1_agent_list_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/agent/list/shopify": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Organization Agents
* @description Get organization agents - supports both JWT and Shopify session token auth
*/
get: operations["get_organization_agents_api_v1_agent_list_shopify_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/agent/{agent_id}/customization": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create Agent Customization
* @description Create or update agent customization - supports both JWT and Shopify session token auth
*/
post: operations["create_agent_customization_api_v1_agent__agent_id__customization_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/agent/{agent_id}/customization/shopify": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create Agent Customization
* @description Create or update agent customization - supports both JWT and Shopify session token auth
*/
post: operations["create_agent_customization_api_v1_agent__agent_id__customization_shopify_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/agent/{agent_id}/customization/photo": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Upload Agent Photo
* @description Upload agent profile photo - supports both JWT and Shopify session token auth
*/
post: operations["upload_agent_photo_api_v1_agent__agent_id__customization_photo_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/agent/{agent_id}/customization/photo/shopify": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Upload Agent Photo
* @description Upload agent profile photo - supports both JWT and Shopify session token auth
*/
post: operations["upload_agent_photo_api_v1_agent__agent_id__customization_photo_shopify_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/agent/{agent_id}/groups": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* Update Agent Groups
* @description Update agent's assigned groups
*/
put: operations["update_agent_groups_api_v1_agent__agent_id__groups_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/agent/generate-instructions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Generate Instructions
* @description Generate agent instructions using AI
*/
post: operations["generate_instructions_api_v1_agent_generate_instructions_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/agent/{agent_id}/lead-capture": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Lead Capture Config
* @description Fetch the agent's lead-capture config, lazily creating a default (OFF) row.
*/
get: operations["get_lead_capture_config_api_v1_agent__agent_id__lead_capture_get"];
/**
* Update Lead Capture Config
* @description Full-replace the agent's lead-capture config (whole tab saved at once).
*/
put: operations["update_lead_capture_config_api_v1_agent__agent_id__lead_capture_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/people": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List People
* @description Paginated, filterable list of the org's people.
*
* The default view is identified people (real email, phone, or a qualifying
* capture); anonymous browser sessions live behind view=anonymous — they are
* a lead-capture funnel signal, not directory content.
*/
get: operations["list_people_api_v1_people_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/people/stats": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* People Stats
* @description KPI counters for the People page header.
*/
get: operations["people_stats_api_v1_people_stats_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/people/{customer_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Person
* @description Full profile: captured attributes, lifecycle timeline, conversations.
*/
get: operations["get_person_api_v1_people__customer_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/**
* Update Person
* @description Explicit human edit of a person's name/phone — the identification tool.
*
* This is the one path allowed to CORRECT a phone (the automatic capture
* paths are set-if-absent): a mistyped outbound number must be fixable.
*/
patch: operations["update_person_api_v1_people__customer_id__patch"];
trace?: never;
};
"/api/v1/people/{customer_id}/mark-customer": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Mark As Customer
* @description Manually promote a person to the Customer stage (phase 1: no automated signal).
*/
post: operations["mark_as_customer_api_v1_people__customer_id__mark_customer_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/people/{customer_id}/crm": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Person Crm
* @description CRM state for the drawer: which CRMs the org has connected + where this
* person is already synced.
*/
get: operations["get_person_crm_api_v1_people__customer_id__crm_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/people/{customer_id}/crm-sync": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Sync Person Crm
* @description Manual "Sync now": push this person to every connected CRM, synchronously.
*/
post: operations["sync_person_crm_api_v1_people__customer_id__crm_sync_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/mcp-tools": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Organization Mcp Tools
* @description Get all MCP tools for the current user's organization
*/
get: operations["get_organization_mcp_tools_api_v1_mcp_tools_get"];
put?: never;
/**
* Create Mcp Tool
* @description Create a new MCP tool
*/
post: operations["create_mcp_tool_api_v1_mcp_tools_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/mcp-tools/{mcp_tool_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Mcp Tool
* @description Get a specific MCP tool
*/
get: operations["get_mcp_tool_api_v1_mcp_tools__mcp_tool_id__get"];
/**
* Update Mcp Tool
* @description Update an existing MCP tool
*/
put: operations["update_mcp_tool_api_v1_mcp_tools__mcp_tool_id__put"];
post?: never;
/**
* Delete Mcp Tool
* @description Delete an MCP tool.
*
* Deliberately not behind check_mcp_feature_access: an org whose plan no
* longer carries mcp_tools must still be able to remove its connectors,
* otherwise a downgrade would strand their credentials in env_vars for good.
*/
delete: operations["delete_mcp_tool_api_v1_mcp_tools__mcp_tool_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/mcp-tools/{mcp_tool_id}/test": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Test Mcp Tool
* @description Connect to a configured MCP tool once and report whether it comes up
* and which functions it exposes — surfaces environment problems (e.g. a
* missing npx) that otherwise only show as a silent 0-tool run.
*/
post: operations["test_mcp_tool_api_v1_mcp_tools__mcp_tool_id__test_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/mcp-tools/{mcp_tool_id}/references": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Mcp Tool References
* @description What currently points at this connector, so a delete confirmation can
* name what it is about to break. Deliberately ungated, like the delete it
* precedes.
*/
get: operations["get_mcp_tool_references_api_v1_mcp_tools__mcp_tool_id__references_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/mcp-tools/agent-association": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Add Mcp Tool To Agent
* @description Add MCP tool to agent
*/
post: operations["add_mcp_tool_to_agent_api_v1_mcp_tools_agent_association_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/mcp-tools/agent-association/{mcp_tool_id}/{agent_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Remove Mcp Tool From Agent
* @description Remove MCP tool from agent
*/
delete: operations["remove_mcp_tool_from_agent_api_v1_mcp_tools_agent_association__mcp_tool_id___agent_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/mcp-tools/agent/{agent_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Agent Mcp Tools
* @description Get all MCP tools associated with an agent
*/
get: operations["get_agent_mcp_tools_api_v1_mcp_tools_agent__agent_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/notifications": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Notifications
* @description Get user's notifications with pagination
*/
get: operations["list_notifications_api_v1_notifications_get"];
put?: never;
post?: never;
/**
* Clear Notifications
* @description Delete all of the caller's notifications.
*/
delete: operations["clear_notifications_api_v1_notifications_delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/notifications/{notification_id}/read": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/**
* Mark As Read
* @description Mark a notification as read
*/
patch: operations["mark_as_read_api_v1_notifications__notification_id__read_patch"];
trace?: never;
};
"/api/v1/notifications/read-all": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Mark All As Read
* @description Mark every unread notification as read, in one statement.
*
* The client used to loop over the notifications it had fetched and PATCH each
* one. That page is 50 rows, so anyone with more unread than that could never
* clear the badge however often they tapped "Mark all read" — and it cost 50
* round trips to not fix it.
*/
post: operations["mark_all_as_read_api_v1_notifications_read_all_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/notifications/{notification_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Delete Notification
* @description Delete one notification.
*
* Scoped to the caller: another user's id must 404 rather than delete.
*/
delete: operations["delete_notification_api_v1_notifications__notification_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/notifications/unread-count": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Unread Count
* @description Get count of unread notifications
*/
get: operations["get_unread_count_api_v1_notifications_unread_count_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/notifications/settings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Notification Settings
* @description Get the current user's chat notification preferences
*/
get: operations["get_notification_settings_api_v1_notifications_settings_get"];
/**
* Update Notification Settings
* @description Update the current user's chat notification preferences.
*
* Always scoped to the caller — there is no way to address another user's
* settings, so no permission check beyond authentication is needed.
*/
put: operations["update_notification_settings_api_v1_notifications_settings_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/notifications/test": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Send Test Notification
* @description Send a test notification to the current user
*/
post: operations["send_test_notification_api_v1_notifications_test_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/widgets": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Widgets
* @description List all widgets for the organization
*/
get: operations["list_widgets_api_v1_widgets_get"];
put?: never;
/**
* Create New Widget
* @description Create a new widget for the organization
*/
post: operations["create_new_widget_api_v1_widgets_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/widgets/{widget_id}/data": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Widget Ui
* @description Get widget UI and handle customer authentication
*/
get: operations["get_widget_ui_api_v1_widgets__widget_id__data_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/widgets/{widget_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Widget Data
* @description Get widget data including agent customization
*/
get: operations["get_widget_data_api_v1_widgets__widget_id__get"];
put?: never;
post?: never;
/**
* Remove Widget
* @description Delete a widget
*/
delete: operations["remove_widget_api_v1_widgets__widget_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/widgets/{widget_id}/end-chat": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* End Chat Acknowledgment
* @description Acknowledge end_chat event from widget and close session on backend
*/
post: operations["end_chat_acknowledgment_api_v1_widgets__widget_id__end_chat_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/widgets/agent/{agent_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Widgets By Agent
* @description Get all widgets for a specific agent
*/
get: operations["get_widgets_by_agent_api_v1_widgets_agent__agent_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/groups": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Groups
* @description List all groups in the organization
*/
get: operations["list_groups_api_v1_groups_get"];
put?: never;
/**
* Create Group
* @description Create a new group
*/
post: operations["create_group_api_v1_groups_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/groups/{group_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Group
* @description Get group details including members
*/
get: operations["get_group_api_v1_groups__group_id__get"];
/**
* Update Group
* @description Update group details
*/
put: operations["update_group_api_v1_groups__group_id__put"];
post?: never;
/**
* Delete Group
* @description Delete a group
*/
delete: operations["delete_group_api_v1_groups__group_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/groups/{group_id}/users/{user_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Add User To Group
* @description Add a user to a group
*/
post: operations["add_user_to_group_api_v1_groups__group_id__users__user_id__post"];
/**
* Remove User From Group
* @description Remove a user from a group
*/
delete: operations["remove_user_from_group_api_v1_groups__group_id__users__user_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/roles": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Roles
* @description List all roles in the organization
*/
get: operations["list_roles_api_v1_roles_get"];
put?: never;
/**
* Create Role
* @description Create a new role
*/
post: operations["create_role_api_v1_roles_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/roles/{role_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Role
* @description Get role details including permissions
*/
get: operations["get_role_api_v1_roles__role_id__get"];
/**
* Update Role
* @description Update role details
*/
put: operations["update_role_api_v1_roles__role_id__put"];
post?: never;
/**
* Delete Role
* @description Delete a role
*/
delete: operations["delete_role_api_v1_roles__role_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/roles/{role_id}/permissions/{permission}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Add Role Permission
* @description Add a permission to a role
*/
post: operations["add_role_permission_api_v1_roles__role_id__permissions__permission__post"];
/**
* Remove Role Permission
* @description Remove a permission from a role
*/
delete: operations["remove_role_permission_api_v1_roles__role_id__permissions__permission__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/roles/permissions/all": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Permissions
* @description List all available permissions
*/
get: operations["list_permissions_api_v1_roles_permissions_all_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/sessions/{session_id}/takeover": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Takeover Chat
* @description Take over a chat session
*/
post: operations["takeover_chat_api_v1_sessions__session_id__takeover_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/sessions/{session_id}/route-to-human": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Route Chat To Human
* @description Stop the AI answering this chat and queue it for the team.
*
* Taking a chat over was the only way to silence the AI, which forces whoever
* spots the problem to handle it personally. This hands it to the queue
* instead, leaving it claimable by anyone.
*/
post: operations["route_chat_to_human_api_v1_sessions__session_id__route_to_human_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/sessions/{session_id}/reassign": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Reassign Chat
* @description Reassign a chat session to a different user
*/
post: operations["reassign_chat_api_v1_sessions__session_id__reassign_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/analytics/agent-performance": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Agent Performance
* @description Get agent performance analytics data for the organization
*/
get: operations["get_agent_performance_api_v1_analytics_agent_performance_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/analytics": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Analytics
* @description Get analytics data for the organization
*/
get: operations["get_analytics_api_v1_analytics_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/analytics/customer-analytics": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Customer Analytics
* @description Get customer analytics data for the organization
*/
get: operations["get_customer_analytics_api_v1_analytics_customer_analytics_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/analytics/customer-details/{customer_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Customer Details
* @description Get detailed information about a specific customer
*/
get: operations["get_customer_details_api_v1_analytics_customer_details__customer_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/analytics/sentiment": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Sentiment Analytics
* @description Get sentiment distribution and trends for the organization
*/
get: operations["get_sentiment_analytics_api_v1_analytics_sentiment_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/analytics/session-sentiment/{session_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Session Sentiment
* @description Get sentiment breakdown for a specific session
*/
get: operations["get_session_sentiment_api_v1_analytics_session_sentiment__session_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/jira/status": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Jira Status
* @description Check if Jira is connected for the current organization.
*/
get: operations["jira_status_api_v1_jira_status_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/jira/disconnect": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Disconnect Jira
* @description Disconnect Jira integration for the current organization.
*/
delete: operations["disconnect_jira_api_v1_jira_disconnect_delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/jira/authorize": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Authorize Jira
* @description Start the Jira OAuth flow by redirecting to Jira's authorization page.
*/
get: operations["authorize_jira_api_v1_jira_authorize_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/jira/callback": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Jira Oauth Callback
* @description Handle the OAuth callback from Jira.
* This endpoint handles both successful authentication and cancellation/errors.
*/
get: operations["jira_oauth_callback_api_v1_jira_callback_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/jira/refresh": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Refresh Jira Token
* @description Refresh the Jira access token using the refresh token.
*/
get: operations["refresh_jira_token_api_v1_jira_refresh_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/jira/projects": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Jira Projects
* @description Get all Jira projects for the current organization.
*/
get: operations["get_jira_projects_api_v1_jira_projects_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/jira/projects/{project_key}/issue-types": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Jira Issue Types
* @description Get all issue types for a Jira project.
*/
get: operations["get_jira_issue_types_api_v1_jira_projects__project_key__issue_types_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/jira/priorities": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Jira Priorities
* @description Get all Jira priorities.
*/
get: operations["get_jira_priorities_api_v1_jira_priorities_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/jira/projects/{project_key}/issue-types/{issue_type_id}/has-priority": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Check Priority Availability
* @description Check if priority field is available for a specific project and issue type.
*/
get: operations["check_priority_availability_api_v1_jira_projects__project_key__issue_types__issue_type_id__has_priority_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/jira/issues": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create Jira Issue
* @description Create a new Jira issue.
*/
post: operations["create_jira_issue_api_v1_jira_issues_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/jira/agent-config/{agent_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Agent Jira Config
* @description Get Jira configuration for an agent.
*/
get: operations["get_agent_jira_config_api_v1_jira_agent_config__agent_id__get"];
put?: never;
/**
* Save Agent Jira Config
* @description Save Jira configuration for an agent.
*/
post: operations["save_agent_jira_config_api_v1_jira_agent_config__agent_id__post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/generate-token": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Generate Widget Token
* @description Generate a JWT token for widget authentication.
*
* Only calls with valid API key (in Authorization header) will succeed.
* Frontend receives this token and must pass it to the widget.
*
* The token is signed with CONVERSATION_SECRET_KEY and can be verified by the widget.
*
* Args:
* body: GenerateTokenRequest with widget_id, customer_email, customer_name, ttl_seconds
* request: FastAPI request object (contains widget_app from API key validation)
* db: Database session
* api_key: Validated API key from Authorization header
*
* Returns:
* GenerateTokenResponse with JWT token
*
* Raises:
* HTTPException 401: Invalid or missing API key
* HTTPException 404: Widget not found
* HTTPException 400: Invalid widget_id
*
* Example:
* POST /api/v1/generate-token
* Authorization: Bearer YOUR_API_KEY
* {
* "widget_id": "widget-123",
* "customer_email": "user@example.com",
* "customer_name": "John Doe",
* "ttl_seconds": 3600
* }
*
* Response:
* {
* "success": true,
* "data": {
* "token": "eyJhbGciOiJIUzI1NiIs...",
* "widget_id": "widget-123",
* "expires_in": 3600,
* "expires_at": "2024-11-09T15:00:00",
* "created_at": "2024-11-09T14:00:00"
* }
* }
*/
post: operations["generate_widget_token_api_v1_generate_token_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/refresh-token": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Refresh Widget Token
* @description Rotate a still-valid conversation token, keeping the visitor's identity.
*
* The widget calls this before its token lapses, so a page left open longer than
* `ttl_seconds` doesn't silently drop an identified visitor back to anonymous.
*
* No API key: the request is authenticated by the conversation token it carries,
* which the caller already holds, so rotating it grants nothing new. An expired or
* revoked token is refused - only POST /generate-token (API key) can assert an
* identity - and rotation stops once the chain reaches its absolute ceiling.
*
* Args:
* body: RefreshTokenRequest with the widget_id the token was issued for
* authorization: `Bearer <conversation token>`
*
* Returns:
* GenerateTokenResponse with the replacement token
*
* Raises:
* HTTPException 401: missing, invalid, expired or revoked conversation token
*/
post: operations["refresh_widget_token_api_v1_refresh_token_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/verify-token": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Verify Widget Token
* @description Verify a widget token (for backend validation).
*
* Args:
* token: JWT token to verify
* widget_id: Widget ID to match against token
* db: Database session
* api_key: Validated API key from Authorization header
*
* Returns:
* Token data if valid, error if invalid
*
* Example:
* POST /api/v1/verify-token?token=eyJ...&widget_id=widget-123
* Authorization: Bearer YOUR_API_KEY
*/
post: operations["verify_widget_token_api_v1_verify_token_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/revoke-token": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Revoke Widget Token
* @description Revoke a widget authentication token immediately.
*
* Once revoked, a token becomes invalid even if it hasn't expired naturally.
*
* Use cases:
* - User logout: Revoke tokens when user logs out
* - Permission changes: Invalidate tokens when user role/permissions change
* - Security incident: Revoke compromised tokens
* - Manual revocation: Admin/portal revokes a specific token
*
* Args:
* body: RevokeTokenRequest with token and optional reason
* db: Database session
* api_key: Validated API key from Authorization header
*
* Returns:
* RevokeTokenResponse indicating success/failure
*
* Example:
* POST /api/v1/revoke-token
* Authorization: Bearer YOUR_API_KEY
* {
* "token": "eyJhbGciOiJIUzI1NiIs...",
* "reason": "User logged out"
* }
*
* Response:
* {
* "success": true,
* "message": "Token revoked successfully",
* "revoked_at": "2024-11-09T14:05:00"
* }
*/
post: operations["revoke_widget_token_api_v1_revoke_token_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/widget-apps": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Widget Apps
* @description List all widget apps for current organization.
*
* Requires: manage_organization permission (admin only)
* Requires: Pro plan with widget_apps feature
*/
get: operations["list_widget_apps_api_v1_widget_apps_get"];
put?: never;
/**
* Create Widget App
* @description Create a new widget app with generated API key.
*
* **IMPORTANT:** The API key is shown only once in this response.
* Save it securely - it cannot be retrieved later.
*
* Requires: manage_organization permission (admin only)
* Requires: Pro plan with widget_apps feature
*/
post: operations["create_widget_app_api_v1_widget_apps_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/widget-apps/{app_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Widget App
* @description Get widget app details by ID.
*
* Requires: manage_organization permission (admin only)
* Requires: Pro plan with widget_apps feature
*/
get: operations["get_widget_app_api_v1_widget_apps__app_id__get"];
put?: never;
post?: never;
/**
* Delete Widget App
* @description Delete widget app (soft delete by default, hard delete if hard_delete=true).
*
* Soft delete (default): Sets is_active=False, keeps record for audit trail.
* Hard delete: Permanently removes record (use with caution).
*
* Requires: manage_organization permission (admin only)
* Requires: Pro plan with widget_apps feature
*/
delete: operations["delete_widget_app_api_v1_widget_apps__app_id__delete"];
options?: never;
head?: never;
/**
* Update Widget App
* @description Update widget app (name, description, active status).
*
* Requires: manage_organization permission (admin only)
* Requires: Pro plan with widget_apps feature
*/
patch: operations["update_widget_app_api_v1_widget_apps__app_id__patch"];
trace?: never;
};
"/api/v1/widget-apps/{app_id}/regenerate-key": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Regenerate Api Key
* @description Regenerate API key for widget app.
*
* **IMPORTANT:** The new API key is shown only once in this response.
* Save it securely - it cannot be retrieved later.
* The old key will be immediately invalidated.
*
* Requires: manage_organization permission (admin only)
* Requires: Pro plan with widget_apps feature
*/
post: operations["regenerate_api_key_api_v1_widget_apps__app_id__regenerate_key_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/shopify/exchange-token": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Exchange Session Token
* @description Exchange Shopify session token for offline access token via Shopify token exchange API.
* Called when app is first loaded in embedded context.
* Stores offline access token in database for future Shopify API calls.
*/
post: operations["exchange_session_token_api_v1_shopify_exchange_token_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/shopify/link-organization": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Link Shop To Org
* @description Link Shopify shop to authenticated user's organization after login.
* Called after user logs in via popup window.
*/
post: operations["link_shop_to_org_api_v1_shopify_link_organization_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/shopify/shops": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Shops
* @description Get all shops for the current organization
*/
get: operations["get_shops_api_v1_shopify_shops_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/shopify/shops/{shop_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Shop
* @description Get a shop by ID
*/
get: operations["get_shop_api_v1_shopify_shops__shop_id__get"];
put?: never;
post?: never;
/**
* Delete Shop
* @description Delete a shop and disconnect from Shopify
*/
delete: operations["delete_shop_api_v1_shopify_shops__shop_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/shopify/link-shop/{shop_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Link Shop To Organization
* @description Link a Shopify shop to the current organization after user logs in.
* This is called after successful login from the embedded app flow.
*/
post: operations["link_shop_to_organization_api_v1_shopify_link_shop__shop_id__post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/shopify/status": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Check Connection
* @description Check if Shopify is connected for the current organization
*/
get: operations["check_connection_api_v1_shopify_status_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/shopify/shop-config-status": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Shop Config Status
* @description Check configuration status for a shop (agents configured, widget ID, etc.)
* Uses session token authentication for embedded apps.
*/
get: operations["get_shop_config_status_api_v1_shopify_shop_config_status_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/shopify/organization-domain": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Organization Domain
* @description Get organization domain from the organization table.
* Uses session token authentication for embedded apps.
*/
get: operations["get_organization_domain_api_v1_shopify_organization_domain_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/shopify/update-domain": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* Update Organization Domain
* @description Update organization domain.
* Uses session token authentication for embedded apps.
*/
put: operations["update_organization_domain_api_v1_shopify_update_domain_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/shopify/connected-agents": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Connected Agents
* @description Get all agents connected to a Shopify shop.
* Uses session token authentication for embedded apps.
*/
get: operations["get_connected_agents_api_v1_shopify_connected_agents_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/shopify/agent-config/{agent_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Agent Shopify Config
* @description Get Shopify configuration for an agent.
* Supports both session token auth (embedded) and JWT auth (dashboard).
*/
get: operations["get_agent_shopify_config_api_v1_shopify_agent_config__agent_id__get"];
put?: never;
/**
* Save Agent Shopify Config
* @description Save Shopify configuration for an agent.
* Automatically determines the shop ID for the organization.
* Supports both session token auth (embedded) and JWT auth (dashboard).
*/
post: operations["save_agent_shopify_config_api_v1_shopify_agent_config__agent_id__post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/shopify/webhooks/app-uninstalled": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Shopify App Uninstalled Webhook
* @description Webhook handler for Shopify app uninstallation.
* This endpoint is called by Shopify when a merchant uninstalls the app.
*
* It performs the following cleanup:
* 1. Marks the shop as uninstalled (is_installed = False)
* 2. Disables all agent Shopify configs for this shop
* 3. Optionally: Can clear access tokens for security
*
* Documentation: https://shopify.dev/docs/apps/build/webhooks/subscribe/get-started
*/
post: operations["shopify_app_uninstalled_webhook_api_v1_shopify_webhooks_app_uninstalled_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/shopify/webhooks/customers/data_request": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Shopify Customers Data Request Webhook
* @description GDPR Compliance Webhook: Customer Data Request
*
* This webhook is called when a customer requests access to their data.
* You must provide the customer's data within a specified timeframe.
*
* Shopify sends the following information:
* - shop_id: The ID of the shop
* - shop_domain: The shop's domain
* - customer: Customer information including email, phone
* - orders_requested: List of order IDs the customer has placed
*
* Documentation: https://shopify.dev/docs/apps/build/privacy-law-compliance
*/
post: operations["shopify_customers_data_request_webhook_api_v1_shopify_webhooks_customers_data_request_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/shopify/webhooks/customers/redact": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Shopify Customers Redact Webhook
* @description GDPR Compliance Webhook: Customer Data Erasure
*
* This webhook is called when a customer requests their data to be deleted.
* You must delete all customer data within a specified timeframe.
*
* Shopify sends the following information:
* - shop_id: The ID of the shop
* - shop_domain: The shop's domain
* - customer: Customer information including email, phone
* - orders_to_redact: List of order IDs to redact
*
* Documentation: https://shopify.dev/docs/apps/build/privacy-law-compliance
*/
post: operations["shopify_customers_redact_webhook_api_v1_shopify_webhooks_customers_redact_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/shopify/webhooks/shop/redact": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Shopify Shop Redact Webhook
* @description GDPR Compliance Webhook: Shop Data Erasure
*
* This webhook is called 48 hours after a shop owner uninstalls your app.
* You must delete all shop-related data.
*
* Shopify sends the following information:
* - shop_id: The ID of the shop
* - shop_domain: The shop's domain
*
* Documentation: https://shopify.dev/docs/apps/build/privacy-law-compliance
*/
post: operations["shopify_shop_redact_webhook_api_v1_shopify_webhooks_shop_redact_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/workflow": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create Workflow
* @description Create a new workflow
*/
post: operations["create_workflow_api_v1_workflow_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/workflow/agent/{agent_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Workflow By Agent Id
* @description Get workflow by agent ID
*/
get: operations["get_workflow_by_agent_id_api_v1_workflow_agent__agent_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/workflow/{workflow_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* Update Workflow
* @description Update workflow
*/
put: operations["update_workflow_api_v1_workflow__workflow_id__put"];
post?: never;
/**
* Delete Workflow
* @description Delete workflow
*/
delete: operations["delete_workflow_api_v1_workflow__workflow_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/workflow/{workflow_id}/nodes": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Workflow Nodes
* @description Get all nodes and connections for a workflow
*/
get: operations["get_workflow_nodes_api_v1_workflow__workflow_id__nodes_get"];
/**
* Replace Workflow Nodes
* @description Replace all workflow nodes and connections with cached data
*/
put: operations["replace_workflow_nodes_api_v1_workflow__workflow_id__nodes_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/workflow/{workflow_id}/nodes/{node_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Workflow Node
* @description Get a single workflow node
*/
get: operations["get_workflow_node_api_v1_workflow__workflow_id__nodes__node_id__get"];
/**
* Update Workflow Node
* @description Update a single workflow node with its properties
*/
put: operations["update_workflow_node_api_v1_workflow__workflow_id__nodes__node_id__put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/files/local/{file_path}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Serve Signed Local File
* @description Serve a local-storage attachment through a link from sign_local_key.
*
* The signature is the authorization, as with an S3 presigned URL, because
* the widget loads attachments with plain <img>/<a> tags.
*/
get: operations["serve_signed_local_file_api_v1_files_local__file_path__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/v1/files/download/{file_path}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Download File
* @description Download/serve a file from AWS S3 or local storage
*
* Usage: GET /api/v1/files/download/chat_attachments/org-id/filename.jpg
*/
get: operations["download_file_api_v1_files_download__file_path__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Root */
get: operations["root__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/health": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Health Check */
get: operations["get_health_check"];
put?: never;
post?: never;
delete?: never;
options?: never;
/** Head Health Check */
head: operations["head_health_check"];
patch?: never;
trace?: never;
};
}
export type webhooks = Record<string, never>;
export interface components {
schemas: {
/** AIConfigCreate */
AIConfigCreate: {
model_type: components["schemas"]["AIModelType"];
/** Model Name */
model_name: string;
/**
* Settings
* @default {}
*/
settings: {
[key: string]: unknown;
} | null;
/**
* Api Key
* Format: password
*/
api_key: string;
/** Base Url */
base_url?: string | null;
};
/** AIConfigResponse */
AIConfigResponse: {
/** Id */
id: number;
/**
* Organization Id
* Format: uuid
*/
organization_id: string;
model_type: components["schemas"]["AIModelType"];
/** Model Name */
model_name: string;
/** Is Active */
is_active: boolean;
/**
* Settings
* @default {}
*/
settings: {
[key: string]: unknown;
};
};
/** AIConfigUpdate */
AIConfigUpdate: {
model_type?: components["schemas"]["AIModelType"] | null;
/** Model Name */
model_name?: string | null;
/** Api Key */
api_key?: string | null;
/** Settings */
settings?: {
[key: string]: unknown;
} | null;
/** Base Url */
base_url?: string | null;
};
/**
* AIModelType
* @enum {string}
*/
AIModelType: "OPENAI" | "ANTHROPIC" | "DEEPSEEK" | "GOOGLE" | "GOOGLEVERTEX" | "GROQ" | "MISTRAL" | "HUGGINGFACE" | "OLLAMA" | "XAI" | "OPENAI_COMPATIBLE" | "REPLYPIER";
/** AISetupResponse */
AISetupResponse: {
/** Message */
message: string;
config: components["schemas"]["AIConfigResponse"];
};
/**
* ActionType
* @enum {string}
*/
ActionType: "webhook" | "database" | "email" | "notification" | "custom";
/**
* AdminPasswordReset
* @description An admin setting a new password for someone else in their organization.
*
* No current_password: the admin does not know it — that is the point of a
* reset. The policy check lives here because nobody is around to see the
* form's strength meter when the call arrives from a script.
*/
AdminPasswordReset: {
/** New Password */
new_password: string;
};
/** AgentChannelConfigRequest */
AgentChannelConfigRequest: {
/**
* Agent Id
* Format: uuid
*/
agent_id: string;
/**
* Is Active
* @default true
*/
is_active: boolean;
};
/** AgentCreate */
AgentCreate: {
/** Name */
name: string;
/** Description */
description?: string | null;
agent_type: components["schemas"]["AgentType"];
/** Instructions */
instructions: string[];
/** Tools */
tools?: {
[key: string]: unknown;
}[] | null;
/**
* Is Active
* @default true
*/
is_active: boolean;
/**
* Is Default
* @default false
*/
is_default: boolean;
/**
* Transfer To Human
* @default false
*/
transfer_to_human: boolean;
/**
* Ai Replies Enabled
* @default true
*/
ai_replies_enabled: boolean;
/**
* Channel Quick Replies
* @default false
*/
channel_quick_replies: boolean;
/**
* Ask For Rating
* @default false
*/
ask_for_rating: boolean;
/**
* Handoff Collect Email
* @default true
*/
handoff_collect_email: boolean;
/**
* Handoff Collect Name
* @default true
*/
handoff_collect_name: boolean;
/**
* Enable Rate Limiting
* @default false
*/
enable_rate_limiting: boolean;
/**
* Overall Limit Per Ip
* @description Maximum number of requests allowed per IP address
* @default 100
*/
overall_limit_per_ip: number;
/**
* Requests Per Sec
* @description Number of requests allowed per second
* @default 1
*/
requests_per_sec: number;
/**
* Use Workflow
* @default false
*/
use_workflow: boolean;
/** Active Workflow Id */
active_workflow_id?: string | null;
/** Display Name */
display_name?: string | null;
/**
* Allow Attachments
* @default false
*/
allow_attachments: boolean;
/**
* Allowed Attachment Types
* @description List of allowed attachment type categories: 'images', 'documents', 'office', 'text'. If null/empty, all types allowed.
*/
allowed_attachment_types?: string[] | null;
/**
* Require Token Auth
* @default false
*/
require_token_auth: boolean;
/**
* Ticketing Enabled
* @default true
*/
ticketing_enabled: boolean;
/**
* Topic Scope
* @description Optional one-line business remit used by the platform guardrail's topic-scope line.
*/
topic_scope?: string | null;
/**
* Guardrail Prompt
* @description Scope rule for this agent. Null uses the platform default; edit it to fit your business.
*/
guardrail_prompt?: string | null;
/**
* Guardrail Enabled
* @description Apply the scope rule. Injection and disclosure protections are always on.
* @default true
*/
guardrail_enabled: boolean;
/** Organization Id */
organization_id?: string | null;
};
/** AgentCustomizationResponse */
AgentCustomizationResponse: {
/** Chat Background Color */
chat_background_color?: string | null;
/** Chat Text Color */
chat_text_color?: string | null;
/** Chat Bubble Color */
chat_bubble_color?: string | null;
/** Accent Color */
accent_color?: string | null;
/** Font Family */
font_family?: string | null;
/** Photo Url */
photo_url?: string | null;
/**
* Chat Style
* @default CHATBOT
*/
chat_style: string | null;
/**
* Widget Position
* @default FLOATING
*/
widget_position: string | null;
/** Welcome Title */
welcome_title?: string | null;
/** Welcome Subtitle */
welcome_subtitle?: string | null;
/** Welcome Message */
welcome_message?: string | null;
/** Chat Initiation Messages */
chat_initiation_messages?: string[] | null;
/** Quick Actions */
quick_actions?: string[] | null;
/** Show Citations */
show_citations?: boolean | null;
/** Collect Email */
collect_email?: boolean | null;
/** Show Ai Disclaimer */
show_ai_disclaimer?: boolean | null;
/** Allow New Chat */
allow_new_chat?: boolean | null;
/** Customization Metadata */
customization_metadata?: {
[key: string]: unknown;
} | null;
};
/** AgentInfo */
AgentInfo: {
/**
* Id
* Format: uuid
*/
id: string;
/** Name */
name: string;
/** Display Name */
display_name: string | null;
/**
* Ai Replies Enabled
* @default true
*/
ai_replies_enabled: boolean;
};
/** AgentJiraConfigModel */
AgentJiraConfigModel: {
/** Enabled */
enabled: boolean;
/** Projectkey */
projectKey?: string | null;
/** Issuetypeid */
issueTypeId?: string | null;
};
/** AgentKnowledge */
AgentKnowledge: {
/** Id */
id: number;
/** Name */
name: string;
/** Type */
type: string;
};
/** AgentMCPToolsResponse */
AgentMCPToolsResponse: {
/**
* Id
* Format: uuid
*/
id: string;
/** Name */
name: string;
/**
* Mcp Tools
* @default []
*/
mcp_tools: components["schemas"]["MCPToolResponse"][];
};
/** AgentResponse */
AgentResponse: {
/**
* Id
* Format: uuid
*/
id: string;
/** Name */
name: string;
/** Display Name */
display_name?: string | null;
customization?: components["schemas"]["AgentCustomizationResponse"] | null;
/**
* Workflow
* @default false
*/
workflow: boolean;
};
/**
* AgentRosterItem
* @description An AI agent as the inbox filter needs it: a name to group chats by.
*
* Deliberately none of AgentResponse's configuration — `instructions`, and
* especially `guardrail_prompt`, which tells a reader how to phrase a bypass.
*/
AgentRosterItem: {
/**
* Id
* Format: uuid
*/
id: string;
/** Name */
name: string;
/** Display Name */
display_name?: string | null;
/**
* Is Active
* @default true
*/
is_active: boolean;
};
/**
* AgentShopifyConfig
* @description Schema for API response.
*/
AgentShopifyConfig: {
/** Enabled */
enabled: boolean;
/** Shop Id */
shop_id?: string | null;
/** Id */
id: string;
/** Agent Id */
agent_id: string;
/**
* Created At
* Format: date-time
*/
created_at: string;
/**
* Updated At
* Format: date-time
*/
updated_at: string;
shop?: components["schemas"]["ShopifyShopInfo"] | null;
};
/**
* AgentShopifyConfigBase
* @description Base Shopify agent configuration schema.
*/
AgentShopifyConfigBase: {
/** Enabled */
enabled: boolean;
/** Shop Id */
shop_id?: string | null;
};
/**
* AgentType
* @enum {string}
*/
AgentType: "customer_support" | "sales" | "tech_support" | "general" | "custom";
/** AgentUpdate */
AgentUpdate: {
/** Display Name */
display_name?: string | null;
/** Instructions */
instructions?: string[] | null;
/** Is Active */
is_active?: boolean | null;
/** Transfer To Human */
transfer_to_human?: boolean | null;
/** Ai Replies Enabled */
ai_replies_enabled?: boolean | null;
/** Channel Quick Replies */
channel_quick_replies?: boolean | null;
/** Ask For Rating */
ask_for_rating?: boolean | null;
/** Handoff Collect Email */
handoff_collect_email?: boolean | null;
/** Handoff Collect Name */
handoff_collect_name?: boolean | null;
/** Enable Rate Limiting */
enable_rate_limiting?: boolean | null;
/** Overall Limit Per Ip */
overall_limit_per_ip?: number | null;
/** Requests Per Sec */
requests_per_sec?: number | null;
/** Use Workflow */
use_workflow?: boolean | null;
/** Active Workflow Id */
active_workflow_id?: string | null;
/** Allow Attachments */
allow_attachments?: boolean | null;
/**
* Allowed Attachment Types
* @description List of allowed attachment type categories: 'images', 'documents', 'office', 'text'. If null/empty, all types allowed.
*/
allowed_attachment_types?: string[] | null;
/** Require Token Auth */
require_token_auth?: boolean | null;
/** Ticketing Enabled */
ticketing_enabled?: boolean | null;
/** Topic Scope */
topic_scope?: string | null;
/** Guardrail Prompt */
guardrail_prompt?: string | null;
/** Guardrail Enabled */
guardrail_enabled?: boolean | null;
};
/** AgentWithCustomizationResponse */
AgentWithCustomizationResponse: {
/**
* Id
* Format: uuid
*/
id: string;
/** Name */
name: string;
/** Display Name */
display_name: string | null;
/** Description */
description: string | null;
agent_type: components["schemas"]["AgentType"];
/** Instructions */
instructions: string[];
/** Is Active */
is_active: boolean;
/**
* Organization Id
* Format: uuid
*/
organization_id: string;
/**
* Knowledge
* @default []
*/
knowledge: components["schemas"]["AgentKnowledge"][];
/**
* Transfer To Human
* @default false
*/
transfer_to_human: boolean;
/**
* Ai Replies Enabled
* @default true
*/
ai_replies_enabled: boolean;
/**
* Channel Quick Replies
* @default false
*/
channel_quick_replies: boolean;
/**
* Ask For Rating
* @default false
*/
ask_for_rating: boolean;
/**
* Handoff Collect Email
* @default true
*/
handoff_collect_email: boolean;
/**
* Handoff Collect Name
* @default true
*/
handoff_collect_name: boolean;
/** Enable Rate Limiting */
enable_rate_limiting?: boolean | null;
/** Overall Limit Per Ip */
overall_limit_per_ip?: number | null;
/** Requests Per Sec */
requests_per_sec?: number | null;
/**
* Use Workflow
* @default false
*/
use_workflow: boolean | null;
/** Active Workflow Id */
active_workflow_id?: string | null;
/**
* Allow Attachments
* @default false
*/
allow_attachments: boolean;
/** Allowed Attachment Types */
allowed_attachment_types?: string[] | null;
/**
* Require Token Auth
* @default false
*/
require_token_auth: boolean;
/**
* Ticketing Enabled
* @default true
*/
ticketing_enabled: boolean;
/** Topic Scope */
topic_scope?: string | null;
/** Guardrail Prompt */
guardrail_prompt?: string | null;
/**
* Guardrail Enabled
* @default true
*/
guardrail_enabled: boolean;
/** Created At */
created_at?: string | null;
/** Updated At */
updated_at?: string | null;
customization?: components["schemas"]["CustomizationResponse"] | null;
/**
* Groups
* @default []
*/
groups: components["schemas"]["app__models__schemas__user_group__UserGroupResponse"][];
};
/** Body_add_subpage_api_v1_knowledge__knowledge_id__subpage_post */
Body_add_subpage_api_v1_knowledge__knowledge_id__subpage_post: {
/** Subpage Name */
subpage_name: string;
/** Content */
content: string;
/** Url */
url?: string | null;
};
/** Body_login_api_v1_users_login_post */
Body_login_api_v1_users_login_post: {
/** Grant Type */
grant_type?: string | null;
/** Username */
username: string;
/**
* Password
* Format: password
*/
password: string;
/**
* Scope
* @default
*/
scope: string;
/** Client Id */
client_id?: string | null;
/**
* Client Secret
* Format: password
*/
client_secret?: string | null;
};
/** Body_start_pdf_import_api_v1_help_center_import_pdf_post */
Body_start_pdf_import_api_v1_help_center_import_pdf_post: {
/** File */
file: string;
};
/** Body_update_chunk_content_api_v1_knowledge__knowledge_id__chunk__chunk_id__put */
Body_update_chunk_content_api_v1_knowledge__knowledge_id__chunk__chunk_id__put: {
/** Content */
content: string;
};
/** Body_update_page_content_api_v1_knowledge__knowledge_id__page__page_id__put */
Body_update_page_content_api_v1_knowledge__knowledge_id__page__page_id__put: {
/** Content */
content: string;
/** Title */
title?: string | null;
};
/** Body_upload_agent_photo_api_v1_agent__agent_id__customization_photo_post */
Body_upload_agent_photo_api_v1_agent__agent_id__customization_photo_post: {
/** Photo */
photo: string;
};
/** Body_upload_agent_photo_api_v1_agent__agent_id__customization_photo_shopify_post */
Body_upload_agent_photo_api_v1_agent__agent_id__customization_photo_shopify_post: {
/** Photo */
photo: string;
};
/** Body_upload_faq_image_api_v1_help_center_faqs_image_post */
Body_upload_faq_image_api_v1_help_center_faqs_image_post: {
/** File */
file: string;
};
/** Body_upload_favicon_api_v1_help_center_favicon_post */
Body_upload_favicon_api_v1_help_center_favicon_post: {
/** File */
file: string;
};
/** Body_upload_logo_api_v1_help_center_logo_post */
Body_upload_logo_api_v1_help_center_logo_post: {
/** File */
file: string;
};
/** Body_upload_pdf_files_api_v1_knowledge_upload_pdf_post */
Body_upload_pdf_files_api_v1_knowledge_upload_pdf_post: {
/** Files */
files: string[];
/** Org Id */
org_id: string;
/** Agent Id */
agent_id?: string | null;
};
/** Body_upload_profile_pic_api_v1_users_me_profile_pic_post */
Body_upload_profile_pic_api_v1_users_me_profile_pic_post: {
/** File */
file: string;
};
/** BusinessHours */
BusinessHours: {
/** Start */
start: string;
/** End */
end: string;
/** Enabled */
enabled: boolean;
};
/** BusinessHoursDict */
BusinessHoursDict: {
monday: components["schemas"]["BusinessHours"];
tuesday: components["schemas"]["BusinessHours"];
wednesday: components["schemas"]["BusinessHours"];
thursday: components["schemas"]["BusinessHours"];
friday: components["schemas"]["BusinessHours"];
saturday: components["schemas"]["BusinessHours"];
sunday: components["schemas"]["BusinessHours"];
};
/**
* ChannelAccountOut
* @description Connected channel account as exposed to the settings UI (no secrets).
*/
ChannelAccountOut: {
/**
* Id
* Format: uuid
*/
id: string;
/** Channel Type */
channel_type: string;
/** External Account Id */
external_account_id: string;
/** Display Name */
display_name?: string | null;
/** Is Active */
is_active: boolean;
/** Agent Id */
agent_id?: string | null;
/** Created At */
created_at?: string | null;
/** Webhook Url */
webhook_url?: string | null;
/**
* Needs Reconnect
* @default false
*/
needs_reconnect: boolean;
/** Webhook Verify Token */
webhook_verify_token?: string | null;
/** Webhook Auto Configured */
webhook_auto_configured?: boolean | null;
};
/** ChatDetailResponse */
ChatDetailResponse: {
customer: components["schemas"]["CustomerInfo"];
agent: components["schemas"]["AgentInfo"];
/** Messages */
messages: components["schemas"]["Message"][];
status: components["schemas"]["SessionStatus"];
/**
* Channel
* @default web
*/
channel: string;
/** Channel Account Id */
channel_account_id?: string | null;
/** Group Id */
group_id: string | null;
/**
* Session Id
* Format: uuid
*/
session_id: string;
/** User Id */
user_id: string | null;
/** User Name */
user_name: string | null;
/**
* Created At
* Format: date-time
*/
created_at: string;
/**
* Updated At
* Format: date-time
*/
updated_at: string;
};
/** ChatOverviewResponse */
ChatOverviewResponse: {
customer: components["schemas"]["CustomerInfo"];
agent: components["schemas"]["AgentInfo"];
/** Last Message */
last_message?: string | null;
/**
* Updated At
* Format: date-time
*/
updated_at: string;
/** Message Count */
message_count: number;
status: components["schemas"]["SessionStatus"];
/**
* Channel
* @default web
*/
channel: string;
/** Group Id */
group_id: string | null;
/** User Id */
user_id?: string | null;
/** User Name */
user_name?: string | null;
/**
* Session Id
* Format: uuid
*/
session_id: string;
};
/**
* ChatStyle
* @enum {string}
*/
ChatStyle: "CHATBOT" | "ASK_ANYTHING" | "GLASS" | "TERMINAL" | "PLAYFUL" | "CALM_MINT" | "AURORA" | "SUNRISE";
/** CreateJiraIssueModel */
CreateJiraIssueModel: {
/** Projectkey */
projectKey: string;
/** Issuetypeid */
issueTypeId: string;
/** Summary */
summary: string;
/** Description */
description: string;
/** Priority */
priority?: string | null;
/** Chatid */
chatId?: string | null;
};
/**
* CrmConnectionOut
* @description A connected CRM as shown on the integrations page. Never exposes
* credentials — only identity and health.
*/
CrmConnectionOut: {
/** Provider */
provider: string;
/** Status */
status: string;
/** Display Name */
display_name?: string | null;
/** External Account Id */
external_account_id: string;
/** Last Error */
last_error?: string | null;
/** Created At */
created_at?: string | null;
/**
* Recent Failures
* @default 0
*/
recent_failures: number;
};
/**
* CrmCustomerSyncOut
* @description One CRM link for a person, shown on the People drawer.
*/
CrmCustomerSyncOut: {
/** Provider */
provider: string;
/** Contact Id */
contact_id?: string | null;
/** Record Url */
record_url?: string | null;
/** Synced At */
synced_at?: string | null;
};
/**
* CrmSyncTarget
* @description Which CRM a qualified lead syncs to.
*
* Stored as a plain string column (not a DB enum) so adding a CRM never
* requires a schema migration — mirrors ChannelType. str() is the value so
* in-memory enum instances and refreshed-from-DB strings render identically.
* @enum {string}
*/
CrmSyncTarget: "none" | "hubspot" | "pipedrive" | "salesforce";
/** CrmTestResult */
CrmTestResult: {
/** Ok */
ok: boolean;
/** Account Name */
account_name?: string | null;
/** Error */
error?: string | null;
};
/** CustomerInfo */
CustomerInfo: {
/**
* Id
* Format: uuid
*/
id: string;
/** Email */
email: string | null;
/** Full Name */
full_name: string | null;
/** Meta Data */
meta_data?: {
[key: string]: unknown;
} | null;
};
/** CustomizationCreate */
CustomizationCreate: {
/** Photo Url */
photo_url?: string | null;
/**
* Chat Background Color
* @default #F8F9FA
*/
chat_background_color: string | null;
/**
* Chat Bubble Color
* @default #E9ECEF
*/
chat_bubble_color: string | null;
/**
* Chat Text Color
* @default #212529
*/
chat_text_color: string | null;
/** Icon Url */
icon_url?: string | null;
/**
* Icon Color
* @default #6C757D
*/
icon_color: string | null;
/**
* Accent Color
* @default #f34611
*/
accent_color: string | null;
/**
* Font Family
* @default Inter, system-ui, sans-serif
*/
font_family: string | null;
/** Custom Css */
custom_css?: string | null;
/**
* Customization Metadata
* @default {}
*/
customization_metadata: {
[key: string]: unknown;
} | null;
/** @default CHATBOT */
chat_style: components["schemas"]["ChatStyle"] | null;
/** @default FLOATING */
widget_position: components["schemas"]["WidgetPosition"] | null;
/** Welcome Title */
welcome_title?: string | null;
/** Welcome Subtitle */
welcome_subtitle?: string | null;
/** Welcome Message */
welcome_message?: string | null;
/** Chat Initiation Messages */
chat_initiation_messages?: string[] | null;
/** Quick Actions */
quick_actions?: string[] | null;
/**
* Show Citations
* @default false
*/
show_citations: boolean | null;
/**
* Collect Email
* @default false
*/
collect_email: boolean | null;
/**
* Show Ai Disclaimer
* @default true
*/
show_ai_disclaimer: boolean | null;
/**
* Allow New Chat
* @default false
*/
allow_new_chat: boolean | null;
};
/** CustomizationResponse */
CustomizationResponse: {
/** Photo Url */
photo_url?: string | null;
/**
* Chat Background Color
* @default #F8F9FA
*/
chat_background_color: string | null;
/**
* Chat Bubble Color
* @default #E9ECEF
*/
chat_bubble_color: string | null;
/**
* Chat Text Color
* @default #212529
*/
chat_text_color: string | null;
/** Icon Url */
icon_url?: string | null;
/**
* Icon Color
* @default #6C757D
*/
icon_color: string | null;
/**
* Accent Color
* @default #f34611
*/
accent_color: string | null;
/**
* Font Family
* @default Inter, system-ui, sans-serif
*/
font_family: string | null;
/** Custom Css */
custom_css?: string | null;
/**
* Customization Metadata
* @default {}
*/
customization_metadata: {
[key: string]: unknown;
} | null;
/** @default CHATBOT */
chat_style: components["schemas"]["ChatStyle"] | null;
/** @default FLOATING */
widget_position: components["schemas"]["WidgetPosition"] | null;
/** Welcome Title */
welcome_title?: string | null;
/** Welcome Subtitle */
welcome_subtitle?: string | null;
/** Welcome Message */
welcome_message?: string | null;
/** Chat Initiation Messages */
chat_initiation_messages?: string[] | null;
/** Quick Actions */
quick_actions?: string[] | null;
/**
* Show Citations
* @default false
*/
show_citations: boolean | null;
/**
* Collect Email
* @default false
*/
collect_email: boolean | null;
/**
* Show Ai Disclaimer
* @default true
*/
show_ai_disclaimer: boolean | null;
/**
* Allow New Chat
* @default false
*/
allow_new_chat: boolean | null;
/** Id */
id: number;
/**
* Agent Id
* Format: uuid
*/
agent_id: string;
};
/** DBConnectorColumnOut */
DBConnectorColumnOut: {
/** Name */
name: string;
/** Type */
type: string;
};
/** DBConnectorCreate */
DBConnectorCreate: {
/**
* Ssh Enabled
* @default false
*/
ssh_enabled: boolean;
/** Ssh Host */
ssh_host?: string | null;
/**
* Ssh Port
* @default 22
*/
ssh_port: number;
/** Ssh Username */
ssh_username?: string | null;
/** Ssh Password */
ssh_password?: string | null;
/** Ssh Private Key */
ssh_private_key?: string | null;
/** Ssh Private Key Passphrase */
ssh_private_key_passphrase?: string | null;
/** Name */
name: string;
/** Engine */
engine: string;
/** Host */
host: string;
/** Port */
port: number;
/** Database */
database: string;
/** Username */
username: string;
/** Password */
password: string;
/**
* Enabled
* @default true
*/
enabled: boolean;
/** Allowed Tables */
allowed_tables?: string[];
/** Masked Columns */
masked_columns?: string[];
/**
* Row Scope
* @description Tables restricted to the ticket customer's own rows, as {"schema.table": "customer_column"}. Listed tables are rewritten into a pre-filtered subquery; tables left out are readable in full.
*/
row_scope?: {
[key: string]: string;
};
/**
* Row Scope Key
* @default email
*/
row_scope_key: string;
/**
* Max Rows
* @default 100
*/
max_rows: number;
/**
* Statement Timeout Ms
* @default 5000
*/
statement_timeout_ms: number;
};
/**
* DBConnectorDiscoverRequest
* @description Pre-save connection test: credentials go over TLS, are used once for
* discovery, and are never persisted by this endpoint.
*/
DBConnectorDiscoverRequest: {
/**
* Ssh Enabled
* @default false
*/
ssh_enabled: boolean;
/** Ssh Host */
ssh_host?: string | null;
/**
* Ssh Port
* @default 22
*/
ssh_port: number;
/** Ssh Username */
ssh_username?: string | null;
/** Ssh Password */
ssh_password?: string | null;
/** Ssh Private Key */
ssh_private_key?: string | null;
/** Ssh Private Key Passphrase */
ssh_private_key_passphrase?: string | null;
/** Engine */
engine: string;
/** Host */
host: string;
/** Port */
port: number;
/** Database */
database: string;
/** Username */
username: string;
/** Password */
password: string;
};
/** DBConnectorDiscoverResponse */
DBConnectorDiscoverResponse: {
/** Ok */
ok: boolean;
/** Error */
error?: string | null;
/**
* Tables
* @default []
*/
tables: components["schemas"]["DBConnectorTableOut"][];
};
/**
* DBConnectorOut
* @description Never includes the password in any form.
*/
DBConnectorOut: {
/**
* Id
* Format: uuid
*/
id: string;
/** Name */
name: string;
/** Engine */
engine: string;
/** Host */
host: string;
/** Port */
port: number;
/** Database */
database: string;
/** Username */
username: string;
/** Enabled */
enabled: boolean;
/** Allowed Tables */
allowed_tables?: string[] | null;
/** Masked Columns */
masked_columns?: string[] | null;
/** Row Scope */
row_scope?: {
[key: string]: string;
} | null;
/**
* Row Scope Key
* @default email
*/
row_scope_key: string;
/** Max Rows */
max_rows: number;
/** Statement Timeout Ms */
statement_timeout_ms: number;
/**
* Ssh Enabled
* @default false
*/
ssh_enabled: boolean;
/** Ssh Host */
ssh_host?: string | null;
/**
* Ssh Port
* @default 22
*/
ssh_port: number;
/** Ssh Username */
ssh_username?: string | null;
/** Last Test At */
last_test_at?: string | null;
/** Last Test Ok */
last_test_ok?: boolean | null;
/** Created At */
created_at?: string | null;
};
/** DBConnectorTableOut */
DBConnectorTableOut: {
/** Schema */
schema: string;
/** Table */
table: string;
/** Columns */
columns: components["schemas"]["DBConnectorColumnOut"][];
};
/** DBConnectorUpdate */
DBConnectorUpdate: {
/** Name */
name?: string | null;
/** Host */
host?: string | null;
/** Port */
port?: number | null;
/** Database */
database?: string | null;
/** Username */
username?: string | null;
/** Password */
password?: string | null;
/** Enabled */
enabled?: boolean | null;
/** Allowed Tables */
allowed_tables?: string[] | null;
/** Masked Columns */
masked_columns?: string[] | null;
/**
* Row Scope
* @description Tables restricted to the ticket customer's own rows, as {"schema.table": "customer_column"}. Listed tables are rewritten into a pre-filtered subquery; tables left out are readable in full.
*/
row_scope?: {
[key: string]: string;
} | null;
/** Row Scope Key */
row_scope_key?: string | null;
/** Max Rows */
max_rows?: number | null;
/** Statement Timeout Ms */
statement_timeout_ms?: number | null;
/** Ssh Enabled */
ssh_enabled?: boolean | null;
/** Ssh Host */
ssh_host?: string | null;
/** Ssh Port */
ssh_port?: number | null;
/** Ssh Username */
ssh_username?: string | null;
/** Ssh Password */
ssh_password?: string | null;
/** Ssh Private Key */
ssh_private_key?: string | null;
/** Ssh Private Key Passphrase */
ssh_private_key_passphrase?: string | null;
};
/**
* DnsRecord
* @description One row of the DNS-records table in the admin UI.
*/
DnsRecord: {
/** Type */
type: string;
/** Host */
host: string;
/** Value */
value: string;
/** Verified */
verified: boolean;
};
/** DomainRequest */
DomainRequest: {
/** Domain */
domain: string;
};
/**
* DomainStatus
* @enum {string}
*/
DomainStatus: "unverified" | "pending" | "verified";
/** DomainStatusResponse */
DomainStatusResponse: {
/** Custom Domain */
custom_domain?: string | null;
domain_status: components["schemas"]["DomainStatus"];
ssl_status: components["schemas"]["SSLStatus"];
/**
* Records
* @default []
*/
records: components["schemas"]["DnsRecord"][];
/** Domain Verified At */
domain_verified_at?: string | null;
};
/** EmailConnectRequest */
EmailConnectRequest: {
/** Inbound Address */
inbound_address: string;
/** Display Name */
display_name?: string | null;
/** Smtp Host */
smtp_host?: string | null;
/** Smtp Port */
smtp_port?: number | null;
/** Smtp Username */
smtp_username?: string | null;
/** Smtp Password */
smtp_password?: string | null;
/** From Email */
from_email?: string | null;
/** Smtp Use Ssl */
smtp_use_ssl?: boolean | null;
};
/**
* EmbeddedSignupConfigOut
* @description Tells the connect UI whether to offer Embedded Signup. Everything but
* `enabled` is None when it isn't, so nothing leaks to orgs without it.
*/
EmbeddedSignupConfigOut: {
/** Enabled */
enabled: boolean;
/** Config Id */
config_id?: string | null;
/** App Id */
app_id?: string | null;
/** Graph Version */
graph_version: string;
};
/**
* EmbeddedSignupRequest
* @description What the Embedded Signup JS SDK hands back: a short-lived code to trade
* for the customer's business token, plus the assets it created.
*/
EmbeddedSignupRequest: {
/** Code */
code: string;
/** Waba Id */
waba_id: string;
/** Phone Number Id */
phone_number_id: string;
/** Display Name */
display_name?: string | null;
};
/**
* EndChatReasonType
* @enum {string}
*/
EndChatReasonType: "ISSUE_RESOLVED" | "CUSTOMER_REQUEST" | "CONFIRMATION_RECEIVED" | "FAREWELL" | "THANK_YOU" | "NATURAL_CONCLUSION" | "TASK_COMPLETED";
/** FAQBulkDeleteRequest */
FAQBulkDeleteRequest: {
/** Faq Ids */
faq_ids: string[];
};
/** FAQBulkStatusRequest */
FAQBulkStatusRequest: {
/** Faq Ids */
faq_ids: string[];
status: components["schemas"]["FAQStatus"];
};
/** FAQCreate */
FAQCreate: {
/** Slug */
slug?: string | null;
/** Url Path */
url_path?: string | null;
/** Meta Title */
meta_title?: string | null;
/** Meta Description */
meta_description?: string | null;
/** Question */
question: string;
/** Answer */
answer: string;
/**
* Category
* @default General
*/
category: string;
/** @default draft */
status: components["schemas"]["FAQStatus"];
};
/** FAQListResponse */
FAQListResponse: {
/** Faqs */
faqs: components["schemas"]["FAQResponse"][];
pagination: components["schemas"]["Pagination"];
};
/** FAQResponse */
FAQResponse: {
/**
* Id
* Format: uuid
*/
id: string;
/** Question */
question: string;
/** Answer */
answer: string;
/** Category */
category: string;
/** Slug */
slug?: string | null;
/** Url Path */
url_path?: string | null;
/** Source Url */
source_url?: string | null;
/** Meta Title */
meta_title?: string | null;
/** Meta Description */
meta_description?: string | null;
status: components["schemas"]["FAQStatus"];
/** Knowledge Id */
knowledge_id?: number | null;
/** Source Label */
source_label?: string | null;
/**
* Helpful Yes
* @default 0
*/
helpful_yes: number;
/**
* Helpful No
* @default 0
*/
helpful_no: number;
/** Created At */
created_at?: string | null;
/** Updated At */
updated_at?: string | null;
};
/**
* FAQStatus
* @enum {string}
*/
FAQStatus: "draft" | "published";
/**
* FAQUpdate
* @description Partial update — omitted fields keep their current values (apply with
* model_dump(exclude_unset=True)), so e.g. a status-only PATCH can't silently
* reset the category to its default.
*/
FAQUpdate: {
/** Slug */
slug?: string | null;
/** Url Path */
url_path?: string | null;
/** Meta Title */
meta_title?: string | null;
/** Meta Description */
meta_description?: string | null;
/** Question */
question?: string | null;
/** Answer */
answer?: string | null;
/** Category */
category?: string | null;
status?: components["schemas"]["FAQStatus"] | null;
};
/** FCMTokenUpdate */
FCMTokenUpdate: {
/** Token */
token: string;
};
/**
* GenerateRequest
* @description Optional narrowing to specific knowledge sources; empty = new sources
* only (those without FAQs yet).
*/
GenerateRequest: {
/** Knowledge Ids */
knowledge_ids?: number[] | null;
};
/**
* GenerateTokenRequest
* @description Request to generate widget token - requires API key in Authorization header
*/
GenerateTokenRequest: {
/** Widget Id */
widget_id: string;
/** Customer Email */
customer_email?: string | null;
/** Customer Name */
customer_name?: string | null;
/** Custom Data */
custom_data?: {
[key: string]: unknown;
} | null;
/**
* Ttl Seconds
* @default 3600
*/
ttl_seconds: number | null;
};
/**
* GenerateTokenResponse
* @description Response with generated token
*/
GenerateTokenResponse: {
/** Success */
success: boolean;
data: components["schemas"]["TokenData"];
/** Message */
message?: string | null;
};
/**
* GenerationEstimateResponse
* @description Confirm-dialog / source-picker numbers for a generation run.
* remaining_credits is None when unlimited (OSS, no cap, or own model key).
*/
GenerationEstimateResponse: {
/** Total Sources */
total_sources: number;
/** New Sources */
new_sources: number;
/** Pages */
pages: number;
/** Estimated Calls */
estimated_calls: number;
/** Metered */
metered: boolean;
/** Remaining Credits */
remaining_credits?: number | null;
/**
* Sources
* @default []
*/
sources: components["schemas"]["GenerationSourceResponse"][];
};
/** GenerationJobResponse */
GenerationJobResponse: {
/** Id */
id: number;
/** Job Type */
job_type: string;
/** Status */
status: string;
/** Stage */
stage: string;
/** Progress Percentage */
progress_percentage: number;
/** Faqs Created */
faqs_created: number;
/** Source Url */
source_url?: string | null;
/** Error */
error?: string | null;
/** Created At */
created_at?: string | null;
};
/**
* GenerationSourceResponse
* @description One knowledge source in the generation picker.
*/
GenerationSourceResponse: {
/** Id */
id: number;
/** Name */
name: string;
/** Source Type */
source_type: string;
/** Has Faqs */
has_faqs: boolean;
/** Pages */
pages: number;
/** Estimated Calls */
estimated_calls: number;
};
/** HTTPValidationError */
HTTPValidationError: {
/** Detail */
detail?: components["schemas"]["ValidationError"][];
};
/** HeaderLink */
HeaderLink: {
/** Label */
label: string;
/** Url */
url: string;
};
/**
* HelpCenterAgentOption
* @description Org agents offered in the AI-search agent selector.
*/
HelpCenterAgentOption: {
/**
* Id
* Format: uuid
*/
id: string;
/** Name */
name: string;
/** Has Widget */
has_widget: boolean;
};
/** HelpCenterSettingsResponse */
HelpCenterSettingsResponse: {
/** Enabled */
enabled: boolean;
/** Slug */
slug?: string | null;
/** Title */
title?: string | null;
/** Description */
description?: string | null;
/** Logo Url */
logo_url?: string | null;
/** Favicon Url */
favicon_url?: string | null;
/** Brand Color */
brand_color: string;
/**
* Header Links
* @default []
*/
header_links: components["schemas"]["HeaderLink"][];
/** Cta Text */
cta_text?: string | null;
/** Cta Url */
cta_url?: string | null;
/** Cta Enabled */
cta_enabled: boolean;
/** Auto Generate */
auto_generate: boolean;
/** Agent Id */
agent_id?: string | null;
/** Ai Search Enabled */
ai_search_enabled: boolean;
/** Chat Widget Enabled */
chat_widget_enabled: boolean;
/** Live Url */
live_url?: string | null;
/**
* Published Count
* @default 0
*/
published_count: number;
/**
* Plan Allowed
* @default true
*/
plan_allowed: boolean;
/**
* Agents
* @default []
*/
agents: components["schemas"]["HelpCenterAgentOption"][];
domain?: components["schemas"]["DomainStatusResponse"] | null;
};
/** HelpCenterSettingsUpdate */
HelpCenterSettingsUpdate: {
/** Enabled */
enabled?: boolean | null;
/** Title */
title?: string | null;
/** Description */
description?: string | null;
/** Brand Color */
brand_color?: string | null;
/** Header Links */
header_links?: components["schemas"]["HeaderLink"][] | null;
/** Cta Text */
cta_text?: string | null;
/** Cta Url */
cta_url?: string | null;
/** Cta Enabled */
cta_enabled?: boolean | null;
/** Auto Generate */
auto_generate?: boolean | null;
/** Agent Id */
agent_id?: string | null;
/** Ai Search Enabled */
ai_search_enabled?: boolean | null;
/** Chat Widget Enabled */
chat_widget_enabled?: boolean | null;
};
/** HumanAgentResponse */
HumanAgentResponse: {
/** Human Agent Name */
human_agent_name?: string | null;
/** Human Agent Profile Pic */
human_agent_profile_pic?: string | null;
};
/** HypothesisOut */
HypothesisOut: {
/**
* Id
* Format: uuid
*/
id: string;
/** Idx */
idx: number;
/** Title */
title: string;
/** Rationale */
rationale?: string | null;
/** Status */
status: string;
/** Confidence */
confidence?: number | null;
/** Conclusion */
conclusion?: string | null;
/** Created At */
created_at?: string | null;
/** Updated At */
updated_at?: string | null;
};
/** ImportRequest */
ImportRequest: {
/** Url */
url: string;
/**
* Mode
* @default qa
* @enum {string}
*/
mode: "qa" | "articles";
/**
* Preserve Urls
* @default false
*/
preserve_urls: boolean;
};
/** InstagramConnectRequest */
InstagramConnectRequest: {
/** Ig Id */
ig_id: string;
/** Page Access Token */
page_access_token: string;
/** Display Name */
display_name?: string | null;
};
/**
* InstagramLoginRequest
* @description What Instagram Business Login hands back. No Page and no asset ids — the
* token itself identifies the single account that signed in, so unlike the
* Messenger flow there is nothing to list or pick.
*
* redirect_uri is the OAuth callback the popup used; the code is bound to it,
* so the token exchange must send the exact same value back.
*/
InstagramLoginRequest: {
/** Code */
code: string;
/** Redirect Uri */
redirect_uri: string;
/** Display Name */
display_name?: string | null;
};
/** InstructionPrompt */
InstructionPrompt: {
/** Prompt */
prompt: string;
/**
* Existing Instructions
* @default []
*/
existing_instructions: string[];
};
/** InvestigateRequest */
InvestigateRequest: {
/** @default investigation */
run_type: components["schemas"]["InvestigationRunType"];
/** Context Note */
context_note?: string | null;
};
/**
* InvestigationDetailResponse
* @description Glass-box payload for the ticket detail page: the (latest or requested)
* investigation run with its hypotheses, evidence events and RCA document.
*/
InvestigationDetailResponse: {
run?: components["schemas"]["InvestigationRunOut"] | null;
/**
* Hypotheses
* @default []
*/
hypotheses: components["schemas"]["HypothesisOut"][];
/**
* Events
* @default []
*/
events: components["schemas"]["InvestigationEventOut"][];
rca?: components["schemas"]["RCADocumentOut"] | null;
proposal?: components["schemas"]["ProposalOut"] | null;
};
/** InvestigationEventOut */
InvestigationEventOut: {
/**
* Id
* Format: uuid
*/
id: string;
/** Hypothesis Id */
hypothesis_id?: string | null;
/** Seq */
seq: number;
/** Event Type */
event_type: string;
/** Label */
label?: string | null;
/** Tool Name */
tool_name?: string | null;
/** Connector Name */
connector_name?: string | null;
/** Tool Input */
tool_input?: string | null;
/** Tool Result */
tool_result?: string | null;
/** Duration Ms */
duration_ms?: number | null;
/** Error */
error?: string | null;
/** Created At */
created_at?: string | null;
};
/** InvestigationRunOut */
InvestigationRunOut: {
/**
* Id
* Format: uuid
*/
id: string;
run_type: components["schemas"]["InvestigationRunType"];
status: components["schemas"]["InvestigationRunStatus"];
/** Trigger */
trigger: string;
/** Error */
error?: string | null;
/**
* Tool Calls Used
* @default 0
*/
tool_calls_used: number;
/**
* Max Tool Calls
* @default 25
*/
max_tool_calls: number;
/**
* Llm Calls
* @default 0
*/
llm_calls: number;
/**
* Input Tokens
* @default 0
*/
input_tokens: number;
/**
* Output Tokens
* @default 0
*/
output_tokens: number;
/**
* Metered
* @default false
*/
metered: boolean;
/** Model Name */
model_name?: string | null;
/** Connector Status */
connector_status?: {
[key: string]: unknown;
} | null;
/** Started At */
started_at?: string | null;
/** Finished At */
finished_at?: string | null;
/** Created At */
created_at?: string | null;
};
/**
* InvestigationRunStatus
* @enum {string}
*/
InvestigationRunStatus: "pending" | "running" | "completed" | "failed" | "cancelled" | "budget_exceeded";
/**
* InvestigationRunType
* @enum {string}
*/
InvestigationRunType: "triage" | "investigation";
/** JiraIssueType */
JiraIssueType: {
/** Id */
id: string;
/** Name */
name: string;
/** Description */
description?: string | null;
};
/** JiraPriority */
JiraPriority: {
/** Id */
id: string;
/** Name */
name: string;
/** Description */
description?: string | null;
/** Iconurl */
iconUrl?: string | null;
};
/** JiraProject */
JiraProject: {
/** Id */
id: string;
/** Key */
key: string;
/** Name */
name: string;
};
/**
* LeadAssignmentMode
* @description Where a qualified lead is routed. Phase 1: stored only, not acted on.
* @enum {string}
*/
LeadAssignmentMode: "none" | "sales_team" | "specific_person" | "round_robin";
/** LeadCaptureConfigResponse */
LeadCaptureConfigResponse: {
/**
* Enabled
* @default false
*/
enabled: boolean;
/**
* Require Consent
* @default true
*/
require_consent: boolean;
/** Guidance */
guidance?: string | null;
/** Fields */
fields?: components["schemas"]["LeadField"][];
/** @default none */
assignment_mode: components["schemas"]["LeadAssignmentMode"];
/** Assignment Target User Id */
assignment_target_user_id?: string | null;
/** @default none */
crm_sync_target: components["schemas"]["CrmSyncTarget"];
/**
* Slack Notify Enabled
* @default false
*/
slack_notify_enabled: boolean;
/**
* Agent Id
* Format: uuid
*/
agent_id: string;
};
/**
* LeadCaptureConfigUpdate
* @description Full-replace payload for the whole Lead Capture tab (mirrors how the
* customization tab saves its entire object in one call).
*/
LeadCaptureConfigUpdate: {
/**
* Enabled
* @default false
*/
enabled: boolean;
/**
* Require Consent
* @default true
*/
require_consent: boolean;
/** Guidance */
guidance?: string | null;
/** Fields */
fields?: components["schemas"]["LeadField"][];
/** @default none */
assignment_mode: components["schemas"]["LeadAssignmentMode"];
/** Assignment Target User Id */
assignment_target_user_id?: string | null;
/** @default none */
crm_sync_target: components["schemas"]["CrmSyncTarget"];
/**
* Slack Notify Enabled
* @default false
*/
slack_notify_enabled: boolean;
};
/**
* LeadField
* @description A detail to collect. Standard fields (email/name/company/phone) carry
* standard=True; custom fields add a label and optional allowed values — which
* the agent uses to steer/normalise the answer in conversation (no form).
*/
LeadField: {
/** Key */
key: string;
/**
* Standard
* @default false
*/
standard: boolean;
/**
* Enabled
* @default true
*/
enabled: boolean;
/**
* Required
* @default false
*/
required: boolean;
/** Label */
label?: string | null;
/** Options */
options?: string[] | null;
};
/**
* LeadStage
* @description Lifecycle stage of a person. Visitor -> Lead is automatic on a qualifying
* capture; Lead -> Customer is a manual transition (phase 1).
* @enum {string}
*/
LeadStage: "visitor" | "lead" | "customer";
/** LineConnectRequest */
LineConnectRequest: {
/** Channel Secret */
channel_secret: string;
/** Channel Access Token */
channel_access_token: string;
};
/** MCPToolCreate */
MCPToolCreate: {
/**
* Name
* @description Display name for the MCP server
*/
name: string;
/**
* Description
* @description Optional description of what this MCP server does
*/
description?: string | null;
/**
* Usage Guidance
* @description What this source holds and how to query it — given to the AI as tool guidance
*/
usage_guidance?: string | null;
transport_type: components["schemas"]["MCPTransportTypeEnum"];
/**
* Enabled
* @description Whether this MCP tool is enabled
* @default true
*/
enabled: boolean;
/**
* Command
* @description Command to run the MCP server (e.g., 'npx', 'uvx', 'node')
*/
command?: string | null;
/**
* Args
* @description Arguments to pass to the MCP server
*/
args?: string[] | null;
/**
* Env Vars
* @description Environment variables as key-value pairs
*/
env_vars?: {
[key: string]: string;
} | null;
/**
* Url
* @description Server URL for SSE/HTTP transport
*/
url?: string | null;
/**
* Headers
* @description HTTP headers as key-value pairs
*/
headers?: {
[key: string]: string;
} | null;
/**
* Timeout
* @description Connection timeout in seconds (1-300)
*/
timeout?: number | null;
/**
* Sse Read Timeout
* @description SSE read timeout in seconds (1-600)
*/
sse_read_timeout?: number | null;
/**
* Terminate On Close
* @description Whether to terminate connection when client is closed (HTTP only)
* @default true
*/
terminate_on_close: boolean | null;
/** Organization Id */
organization_id?: string | null;
};
/**
* MCPToolReferencesResponse
* @description Where a connector is in use, so a delete confirmation can name what it
* is about to break instead of asking blind.
*/
MCPToolReferencesResponse: {
/**
* Agents
* @default []
*/
agents: string[];
/**
* Used In Investigations
* @default false
*/
used_in_investigations: boolean;
};
/** MCPToolResponse */
MCPToolResponse: {
/** Id */
id: number;
/** Name */
name: string;
/** Description */
description: string | null;
/** Usage Guidance */
usage_guidance: string | null;
transport_type: components["schemas"]["MCPTransportTypeEnum"];
/** Enabled */
enabled: boolean;
/** Command */
command: string | null;
/** Args */
args: string[] | null;
/** Env Vars */
env_vars: {
[key: string]: string;
} | null;
/** Url */
url: string | null;
/** Headers */
headers: {
[key: string]: string;
} | null;
/** Timeout */
timeout: number | null;
/** Sse Read Timeout */
sse_read_timeout: number | null;
/** Terminate On Close */
terminate_on_close: boolean | null;
/**
* Organization Id
* Format: uuid
*/
organization_id: string;
/**
* Created At
* Format: date-time
*/
created_at: string;
/**
* Updated At
* Format: date-time
*/
updated_at: string;
};
/**
* MCPToolTestResponse
* @description Result of a one-off connection test against a configured tool.
*/
MCPToolTestResponse: {
/** Success */
success: boolean;
/**
* Functions
* @default []
*/
functions: string[];
/** Error */
error?: string | null;
};
/** MCPToolToAgentCreate */
MCPToolToAgentCreate: {
/** Mcp Tool Id */
mcp_tool_id: number;
/**
* Agent Id
* Format: uuid
*/
agent_id: string;
};
/** MCPToolToAgentResponse */
MCPToolToAgentResponse: {
/** Id */
id: number;
/** Mcp Tool Id */
mcp_tool_id: number;
/**
* Agent Id
* Format: uuid
*/
agent_id: string;
/**
* Created At
* Format: date-time
*/
created_at: string;
mcp_tool: components["schemas"]["MCPToolResponse"];
};
/** MCPToolUpdate */
MCPToolUpdate: {
/** Name */
name?: string | null;
/** Description */
description?: string | null;
/**
* Usage Guidance
* @description What this source holds and how to query it — given to the AI as tool guidance
*/
usage_guidance?: string | null;
transport_type?: components["schemas"]["MCPTransportTypeEnum"] | null;
/** Enabled */
enabled?: boolean | null;
/** Command */
command?: string | null;
/** Args */
args?: string[] | null;
/** Env Vars */
env_vars?: {
[key: string]: string;
} | null;
/** Url */
url?: string | null;
/** Headers */
headers?: {
[key: string]: string;
} | null;
/** Timeout */
timeout?: number | null;
/** Sse Read Timeout */
sse_read_timeout?: number | null;
/** Terminate On Close */
terminate_on_close?: boolean | null;
};
/**
* MCPTransportTypeEnum
* @enum {string}
*/
MCPTransportTypeEnum: "stdio" | "sse" | "http";
/** Message */
Message: {
/** Id */
id?: number | null;
/** Message */
message?: string | null;
/** Message Type */
message_type: string;
/**
* Created At
* Format: date-time
*/
created_at: string;
/** Attributes */
attributes?: {
[key: string]: unknown;
} | null;
/** External Message Id */
external_message_id?: string | null;
/** Channel Status */
channel_status?: string | null;
shopify_output?: components["schemas"]["ShopifyOutputData"] | null;
/** End Chat */
end_chat?: boolean | null;
end_chat_reason?: components["schemas"]["EndChatReasonType"] | null;
/** End Chat Description */
end_chat_description?: string | null;
/** Agent Name */
agent_name?: string | null;
/** User Name */
user_name?: string | null;
/** Attachments */
attachments?: unknown[] | null;
};
/** MessengerConnectRequest */
MessengerConnectRequest: {
/** App Secret */
app_secret?: string | null;
/** Page Id */
page_id: string;
/** Page Access Token */
page_access_token: string;
/** Display Name */
display_name?: string | null;
};
/**
* MessengerPageOut
* @description A Page offered in the picker. Its access token is deliberately absent:
* it travels back inside the opaque signup_token instead.
*/
MessengerPageOut: {
/** Id */
id: string;
/** Name */
name: string;
};
/**
* MessengerSignupConnectRequest
* @description Step 2: the Page picked out of step 1's list. page_id is a selector into
* that list, not a credential — the token is the one we sealed.
*/
MessengerSignupConnectRequest: {
/** Signup Token */
signup_token: string;
/** Page Id */
page_id: string;
/** Display Name */
display_name?: string | null;
};
/**
* MessengerSignupPagesOut
* @description Step 1's result: the Pages to choose from, plus an opaque token that
* carries their access tokens (encrypted) into step 2.
*/
MessengerSignupPagesOut: {
/** Pages */
pages: components["schemas"]["MessengerPageOut"][];
/** Signup Token */
signup_token: string;
};
/**
* MessengerSignupRequest
* @description The code Facebook Login for Business hands back. Unlike WhatsApp's
* Embedded Signup it names no assets — the Pages are ours to look up.
*
* redirect_uri is the OAuth callback URL the login popup used; the code is
* bound to it, so the token exchange must send the exact same value back. The
* client owns it (it must also be a registered Valid OAuth Redirect URI).
*/
MessengerSignupRequest: {
/** Code */
code: string;
/** Redirect Uri */
redirect_uri: string;
};
/**
* NodeType
* @enum {string}
*/
NodeType: "message" | "llm" | "condition" | "form" | "action" | "human_transfer" | "wait" | "end" | "landing_page" | "user_input" | "guardrails";
/** NotificationResponse */
NotificationResponse: {
/** Id */
id: number;
/**
* User Id
* Format: uuid
*/
user_id: string;
type: components["schemas"]["NotificationType"];
/** Title */
title: string;
/** Message */
message: string;
/** Notification Metadata */
notification_metadata?: {
[key: string]: unknown;
} | null;
/** Is Read */
is_read: boolean;
/**
* Created At
* Format: date-time
*/
created_at: string;
};
/**
* NotificationSettingsOut
* @description A user's chat push preferences.
*/
NotificationSettingsOut: {
/** Notify New Chat */
notify_new_chat: boolean;
/** Notify Chat Transfer */
notify_chat_transfer: boolean;
/** Notify Chat Assigned */
notify_chat_assigned: boolean;
};
/**
* NotificationSettingsUpdate
* @description Partial update — only the toggles the caller sent are applied.
*/
NotificationSettingsUpdate: {
/** Notify New Chat */
notify_new_chat?: boolean | null;
/** Notify Chat Transfer */
notify_chat_transfer?: boolean | null;
/** Notify Chat Assigned */
notify_chat_assigned?: boolean | null;
};
/**
* NotificationType
* @enum {string}
*/
NotificationType: "knowledge_processed" | "knowledge_failed" | "faq_generated" | "faq_generation_failed" | "system" | "chat";
/** OrganizationCreate */
OrganizationCreate: {
/** Name */
name: string;
/** Domain */
domain: string;
/**
* Timezone
* @default UTC
*/
timezone: string | null;
/**
* @default {
* "monday": {
* "enabled": true,
* "end": "17:00",
* "start": "09:00"
* },
* "tuesday": {
* "enabled": true,
* "end": "17:00",
* "start": "09:00"
* },
* "wednesday": {
* "enabled": true,
* "end": "17:00",
* "start": "09:00"
* },
* "thursday": {
* "enabled": true,
* "end": "17:00",
* "start": "09:00"
* },
* "friday": {
* "enabled": true,
* "end": "17:00",
* "start": "09:00"
* },
* "saturday": {
* "enabled": false,
* "end": "17:00",
* "start": "09:00"
* },
* "sunday": {
* "enabled": false,
* "end": "17:00",
* "start": "09:00"
* }
* }
*/
business_hours: components["schemas"]["BusinessHoursDict"] | null;
/**
* Settings
* @default {}
*/
settings: {
[key: string]: unknown;
} | null;
/**
* Admin Email
* Format: email
*/
admin_email: string;
/** Admin Name */
admin_name: string;
/** Admin Password */
admin_password: string;
};
/** OrganizationCreateResponse */
OrganizationCreateResponse: {
/** Name */
name: string;
/** Domain */
domain: string;
/**
* Timezone
* @default UTC
*/
timezone: string | null;
/**
* @default {
* "monday": {
* "enabled": true,
* "end": "17:00",
* "start": "09:00"
* },
* "tuesday": {
* "enabled": true,
* "end": "17:00",
* "start": "09:00"
* },
* "wednesday": {
* "enabled": true,
* "end": "17:00",
* "start": "09:00"
* },
* "thursday": {
* "enabled": true,
* "end": "17:00",
* "start": "09:00"
* },
* "friday": {
* "enabled": true,
* "end": "17:00",
* "start": "09:00"
* },
* "saturday": {
* "enabled": false,
* "end": "17:00",
* "start": "09:00"
* },
* "sunday": {
* "enabled": false,
* "end": "17:00",
* "start": "09:00"
* }
* }
*/
business_hours: components["schemas"]["BusinessHoursDict"] | null;
/**
* Settings
* @default {}
*/
settings: {
[key: string]: unknown;
} | null;
/**
* Id
* Format: uuid
*/
id: string;
/** Is Active */
is_active: boolean;
/** Access Token */
access_token?: string | null;
/** Refresh Token */
refresh_token?: string | null;
/** Token Type */
token_type?: string | null;
user: components["schemas"]["UserResponse"];
};
/** OrganizationResponse */
OrganizationResponse: {
/** Name */
name: string;
/** Domain */
domain: string;
/**
* Timezone
* @default UTC
*/
timezone: string | null;
/**
* @default {
* "monday": {
* "enabled": true,
* "end": "17:00",
* "start": "09:00"
* },
* "tuesday": {
* "enabled": true,
* "end": "17:00",
* "start": "09:00"
* },
* "wednesday": {
* "enabled": true,
* "end": "17:00",
* "start": "09:00"
* },
* "thursday": {
* "enabled": true,
* "end": "17:00",
* "start": "09:00"
* },
* "friday": {
* "enabled": true,
* "end": "17:00",
* "start": "09:00"
* },
* "saturday": {
* "enabled": false,
* "end": "17:00",
* "start": "09:00"
* },
* "sunday": {
* "enabled": false,
* "end": "17:00",
* "start": "09:00"
* }
* }
*/
business_hours: components["schemas"]["BusinessHoursDict"] | null;
/**
* Settings
* @default {}
*/
settings: {
[key: string]: unknown;
} | null;
/**
* Id
* Format: uuid
*/
id: string;
/** Is Active */
is_active: boolean;
/** Access Token */
access_token?: string | null;
/** Refresh Token */
refresh_token?: string | null;
/** Token Type */
token_type?: string | null;
};
/** OrganizationUpdate */
OrganizationUpdate: {
/** Name */
name?: string | null;
/** Domain */
domain?: string | null;
/** Timezone */
timezone?: string | null;
business_hours?: components["schemas"]["BusinessHoursDict"] | null;
/** Settings */
settings?: {
[key: string]: unknown;
} | null;
};
/**
* OutboundConversationOut
* @description The session the outbound send created (or reused): everything else —
* the inbox thread, template resend, AI takeover on reply — keys off it.
*/
OutboundConversationOut: {
/**
* Session Id
* Format: uuid
*/
session_id: string;
};
/**
* OutboundConversationRequest
* @description Start a WhatsApp conversation with a phone number — the customer has
* not messaged us; an approved template is the only thing Meta will deliver.
*
* customer_id links the conversation to a person the agent picked in People;
* without it the customer is resolved by phone or created. customer_name
* only names a newly created person (never renames an existing one).
*/
OutboundConversationRequest: {
/** To */
to: string;
/** Template Name */
template_name: string;
/**
* Language
* @default en_US
*/
language: string;
/** Components */
components?: unknown[] | null;
/** Customer Id */
customer_id?: string | null;
/** Customer Name */
customer_name?: string | null;
};
/**
* Pagination
* @description Standard list-endpoint pagination block (shape matches the knowledge
* API's inline dicts: total / page / page_size / total_pages).
*/
Pagination: {
/** Total */
total: number;
/** Page */
page: number;
/** Page Size */
page_size: number;
/** Total Pages */
total_pages: number;
};
/** PeopleListResponse */
PeopleListResponse: {
/** Items */
items: components["schemas"]["PersonListItem"][];
/** Total */
total: number;
/** Page */
page: number;
/** Page Size */
page_size: number;
};
/** PeopleStats */
PeopleStats: {
/** Total People */
total_people: number;
/**
* Anonymous
* @default 0
*/
anonymous: number;
/** New Leads 7D */
new_leads_7d: number;
/** Customers */
customers: number;
/**
* Synced To Crm
* @default 0
*/
synced_to_crm: number;
};
/** PermissionResponse */
PermissionResponse: {
/** Id */
id: number;
/** Name */
name: string;
/** Description */
description: string | null;
};
/** PersonConversation */
PersonConversation: {
/**
* Session Id
* Format: uuid
*/
session_id: string;
/** Agent Name */
agent_name?: string | null;
/** Status */
status?: string | null;
/** Last Message */
last_message?: string | null;
/** Created At */
created_at?: string | null;
};
/**
* PersonCrmStatus
* @description CRM state for a person: which CRMs the org has connected, and where this
* person is already synced.
*/
PersonCrmStatus: {
/** Connected Providers */
connected_providers: string[];
/** Synced */
synced: components["schemas"]["CrmCustomerSyncOut"][];
};
/** PersonDetail */
PersonDetail: {
/**
* Id
* Format: uuid
*/
id: string;
/** Name */
name?: string | null;
/** Email */
email?: string | null;
/** Phone */
phone?: string | null;
/**
* Identified
* @default false
*/
identified: boolean;
/**
* Is Anonymous
* @default false
*/
is_anonymous: boolean;
lead_stage: components["schemas"]["LeadStage"];
/**
* Qualified
* @default false
*/
qualified: boolean;
/** Source */
source?: {
[key: string]: unknown;
} | null;
/** Created At */
created_at?: string | null;
/** Lead Qualified At */
lead_qualified_at?: string | null;
/** Meta Data */
meta_data?: {
[key: string]: unknown;
} | null;
/** Summary */
summary?: string | null;
/**
* Captured Attributes
* @default {}
*/
captured_attributes: {
[key: string]: unknown;
};
/**
* Timeline
* @default []
*/
timeline: components["schemas"]["TimelineEntry"][];
/**
* Conversations
* @default []
*/
conversations: components["schemas"]["PersonConversation"][];
};
/** PersonListItem */
PersonListItem: {
/**
* Id
* Format: uuid
*/
id: string;
/** Name */
name?: string | null;
/** Email */
email?: string | null;
/** Phone */
phone?: string | null;
/**
* Is Anonymous
* @default false
*/
is_anonymous: boolean;
lead_stage: components["schemas"]["LeadStage"];
/**
* Qualified
* @default false
*/
qualified: boolean;
/** Source */
source?: {
[key: string]: unknown;
} | null;
/** Captured At */
captured_at?: string | null;
/** Last Activity */
last_activity?: string | null;
/**
* Synced
* @default false
*/
synced: boolean;
};
/**
* PersonUpdateRequest
* @description Drawer edit: both fields optional; phone "" clears the number.
*/
PersonUpdateRequest: {
/** Full Name */
full_name?: string | null;
/** Phone */
phone?: string | null;
};
/** ProposalOut */
ProposalOut: {
/**
* Id
* Format: uuid
*/
id: string;
/** Run Id */
run_id?: string | null;
/** Summary */
summary: string;
/** Customer Message */
customer_message?: string | null;
/** Confidence */
confidence?: number | null;
/** Status */
status: string;
/** Decided By User Id */
decided_by_user_id?: string | null;
/** Decided By Name */
decided_by_name?: string | null;
/** Decided At */
decided_at?: string | null;
/** Reject Reason */
reject_reason?: string | null;
/** Created At */
created_at?: string | null;
};
/** ProposalRejectRequest */
ProposalRejectRequest: {
/** Reason */
reason?: string | null;
/**
* Reinvestigate
* @default false
*/
reinvestigate: boolean;
};
/** RCADocumentOut */
RCADocumentOut: {
/**
* Id
* Format: uuid
*/
id: string;
/** Run Id */
run_id?: string | null;
/** Version */
version: number;
/** Summary */
summary?: string | null;
/** Impact */
impact?: string | null;
/** Timeline */
timeline?: unknown[] | null;
/** Investigation Log */
investigation_log?: string | null;
/** Contributing Factors */
contributing_factors?: unknown[] | null;
/** Conclusion */
conclusion?: string | null;
/** Remediation */
remediation?: string | null;
/** Prevention */
prevention?: string | null;
/** Customer Summary */
customer_summary?: string | null;
/** Confidence */
confidence?: number | null;
/**
* Is Partial
* @default false
*/
is_partial: boolean;
/**
* Generated By
* @default ai
*/
generated_by: string;
/** Reviewed By User Id */
reviewed_by_user_id?: string | null;
/** Reviewed By Name */
reviewed_by_name?: string | null;
/** Reviewed At */
reviewed_at?: string | null;
/** Created At */
created_at?: string | null;
/** Updated At */
updated_at?: string | null;
};
/** RcaUpdate */
RcaUpdate: {
/** Customer Summary */
customer_summary?: string | null;
/**
* Mark Reviewed
* @default false
*/
mark_reviewed: boolean;
};
/**
* RefreshTokenRequest
* @description Request to rotate a still-valid conversation token
*/
RefreshTokenRequest: {
/** Widget Id */
widget_id: string;
};
/**
* ResolutionOutcome
* @enum {string}
*/
ResolutionOutcome: "fixed" | "workaround" | "not_a_bug" | "duplicate" | "cannot_reproduce" | "customer_unresponsive" | "escalated_external";
/**
* RevokeTokenRequest
* @description Request to revoke a token
*/
RevokeTokenRequest: {
/** Token */
token: string;
/** Reason */
reason?: string | null;
};
/**
* RevokeTokenResponse
* @description Response for token revocation
*/
RevokeTokenResponse: {
/** Success */
success: boolean;
/** Message */
message: string;
/** Revoked At */
revoked_at?: string | null;
};
/** RoleCreate */
RoleCreate: {
/** Name */
name: string;
/** Description */
description?: string | null;
/**
* Is Default
* @default false
*/
is_default: boolean | null;
/** Permissions */
permissions: components["schemas"]["PermissionResponse"][];
};
/** RoleResponse */
RoleResponse: {
/** Name */
name: string;
/** Description */
description?: string | null;
/**
* Is Default
* @default false
*/
is_default: boolean | null;
/** Id */
id: number;
/** Organization Id */
organization_id?: string | null;
/** Created At */
created_at?: string | null;
/** Updated At */
updated_at?: string | null;
/** Permissions */
permissions?: components["schemas"]["PermissionResponse"][] | null;
};
/** RoleUpdate */
RoleUpdate: {
/** Name */
name: string;
/** Description */
description?: string | null;
/**
* Is Default
* @default false
*/
is_default: boolean | null;
/** Permissions */
permissions?: components["schemas"]["PermissionResponse"][] | null;
};
/**
* SSLStatus
* @enum {string}
*/
SSLStatus: "none" | "pending" | "active" | "failed";
/**
* SessionStatus
* @enum {string}
*/
SessionStatus: "open" | "transferred" | "closed";
/**
* ShopifyOutputData
* @description Shopify output model for socket/frontend responses - includes full product data
*/
ShopifyOutputData: {
/** Products */
products?: components["schemas"]["ShopifyProduct"][] | null;
/** Search Query */
search_query?: string | null;
/** Search Type */
search_type?: string | null;
/** Total Count */
total_count?: number | null;
/** Has More */
has_more?: boolean | null;
/**
* Shop Domain
* @description Shopify shop domain for constructing product URLs
*/
shop_domain?: string | null;
/**
* Product Cache Key
* @description Redis cache key for backend reference
*/
product_cache_key?: string | null;
/**
* Product Ids
* @description List of product IDs for backend reference
*/
product_ids?: string[] | null;
};
/** ShopifyProduct */
ShopifyProduct: {
/** Id */
id?: string | null;
/** Title */
title?: string | null;
/** Description */
description?: string | null;
/** Handle */
handle?: string | null;
/** Product Type */
product_type?: string | null;
/** Vendor */
vendor?: string | null;
/** Total Inventory */
total_inventory?: number | null;
/** Price */
price?: string | null;
/** Price Max */
price_max?: string | null;
/** Currency */
currency?: string | null;
image?: components["schemas"]["ShopifyProductImage"] | null;
/** Tags */
tags?: string[] | null;
/** Created At */
created_at?: string | null;
/** Updated At */
updated_at?: string | null;
/** Price Formatted */
price_formatted?: string | null;
/** Variant Title */
variant_title?: string | null;
};
/** ShopifyProductImage */
ShopifyProductImage: {
/** Src */
src?: string | null;
/** Alt */
alt?: string | null;
};
/**
* ShopifyShop
* @description Schema for shopify shop response
*/
ShopifyShop: {
/**
* Shop Domain
* @description Shopify shop domain
*/
shop_domain: string;
/**
* Organization Id
* @description ID of the organization this shop belongs to
*/
organization_id?: string | null;
/** Id */
id: string;
/** Scope */
scope?: string | null;
/** Is Installed */
is_installed: boolean;
/**
* Created At
* Format: date-time
*/
created_at: string;
/**
* Updated At
* Format: date-time
*/
updated_at: string;
};
/**
* ShopifyShopInfo
* @description Basic info about a Shopify shop.
*/
ShopifyShopInfo: {
/** Id */
id: string;
/** Shop Domain */
shop_domain: string;
};
/** SmsConnectRequest */
SmsConnectRequest: {
/** Provider */
provider: string;
/** Phone Number */
phone_number: string;
/**
* Credentials
* @default {}
*/
credentials: {
[key: string]: unknown;
};
};
/** SmsProviderInfo */
SmsProviderInfo: {
/** Name */
name: string;
/** Label */
label: string;
/** Fields */
fields: unknown[];
};
/** TeamAgentStats */
TeamAgentStats: {
/** Id */
id: string;
/** Full Name */
full_name: string;
/** Email */
email: string;
/** Profile Pic */
profile_pic?: string | null;
/**
* Is Online
* @default false
*/
is_online: boolean;
/** Last Seen */
last_seen?: string | null;
/**
* Is Active
* @default true
*/
is_active: boolean;
/** Role */
role?: string | null;
/**
* Is Admin
* @default false
*/
is_admin: boolean;
/**
* Groups
* @default []
*/
groups: string[];
/**
* Active Chats
* @default 0
*/
active_chats: number;
/**
* Resolved Chats
* @default 0
*/
resolved_chats: number;
/**
* Capacity
* @default 5
*/
capacity: number;
};
/** TeamKpis */
TeamKpis: {
/**
* Team Size
* @default 0
*/
team_size: number;
/**
* Admins
* @default 0
*/
admins: number;
/**
* Agents
* @default 0
*/
agents: number;
/**
* Online Now
* @default 0
*/
online_now: number;
/**
* Active Chats
* @default 0
*/
active_chats: number;
/**
* Total Capacity
* @default 0
*/
total_capacity: number;
/**
* Waiting Handoff
* @default 0
*/
waiting_handoff: number;
/**
* Oldest Wait Minutes
* @default 0
*/
oldest_wait_minutes: number;
};
/** TeamOverviewResponse */
TeamOverviewResponse: {
kpis: components["schemas"]["TeamKpis"];
/** Agents */
agents: components["schemas"]["TeamAgentStats"][];
};
/**
* TeammateResponse
* @description A colleague as the inbox needs them: enough to pick one and render them.
*
* No role, no permissions, no timestamps — an agent listing who they can hand
* a chat to has no business reading the org's permission matrix, which is
* what UserResponse would give them.
*/
TeammateResponse: {
/**
* Id
* Format: uuid
*/
id: string;
/** Full Name */
full_name?: string | null;
/**
* Email
* Format: email
*/
email: string;
/** Profile Pic */
profile_pic?: string | null;
/**
* Is Online
* @default false
*/
is_online: boolean | null;
};
/** TelegramConnectRequest */
TelegramConnectRequest: {
/** Bot Token */
bot_token: string;
};
/**
* TemplateLibraryOut
* @description A deep link into Meta's Template Library for one WhatsApp Business
* Account — which is where templates get written. We list and send them; Meta
* authors them.
*/
TemplateLibraryOut: {
/** Url */
url: string;
};
/**
* TemplateOut
* @description A message template as it exists on the customer's WhatsApp Business
* Account. Only APPROVED templates can actually be sent.
*/
TemplateOut: {
/** Id */
id?: string | null;
/** Name */
name: string;
/** Status */
status?: string | null;
/** Category */
category?: string | null;
/** Language */
language?: string | null;
/** Components */
components?: unknown[] | null;
};
/**
* TemplateSendRequest
* @description Reopen an expired WhatsApp window with an approved template.
*/
TemplateSendRequest: {
/**
* Session Id
* Format: uuid
*/
session_id: string;
/** Template Name */
template_name: string;
/**
* Language
* @default en_US
*/
language: string;
/** Components */
components?: unknown[] | null;
};
/** TextSourceRequest */
TextSourceRequest: {
/**
* Org Id
* Format: uuid
*/
org_id: string;
/** Title */
title: string;
/** Content */
content: string;
/** Agent Id */
agent_id?: string | null;
};
/** TicketActivityOut */
TicketActivityOut: {
/**
* Id
* Format: uuid
*/
id: string;
activity_type: components["schemas"]["TicketActivityType"];
actor_type: components["schemas"]["TicketActorType"];
/** Actor User Id */
actor_user_id?: string | null;
/** Actor Name */
actor_name?: string | null;
/** Body */
body?: string | null;
/**
* Is Internal
* @default true
*/
is_internal: boolean;
/** Activity Metadata */
activity_metadata?: {
[key: string]: unknown;
} | null;
/** Created At */
created_at?: string | null;
};
/**
* TicketActivityType
* @enum {string}
*/
TicketActivityType: "comment" | "status_change" | "assignment" | "priority_change" | "ai_triage" | "ai_investigation_started" | "ai_investigation_completed" | "ai_resolution_proposed" | "ai_resolution_approved" | "ai_resolution_rejected" | "customer_notified" | "customer_replied" | "customer_linked" | "csat_requested" | "csat_received" | "reopened" | "jira_escalated";
/**
* TicketActorType
* @enum {string}
*/
TicketActorType: "user" | "ai" | "customer" | "system";
/** TicketCommentCreate */
TicketCommentCreate: {
/** Body */
body: string;
/**
* Is Internal
* @default true
*/
is_internal: boolean;
};
/** TicketCreate */
TicketCreate: {
/** Title */
title: string;
/** Description */
description?: string | null;
/** @default medium */
priority: components["schemas"]["TicketPriority"];
/** Severity */
severity?: number | null;
/** Tags */
tags?: string[] | null;
/** Customer Id */
customer_id?: string | null;
/** Customer Email */
customer_email?: string | null;
/** Customer Name */
customer_name?: string | null;
/** Session Id */
session_id?: string | null;
/** Assignee User Id */
assignee_user_id?: string | null;
/** Group Id */
group_id?: string | null;
};
/** TicketCustomerOut */
TicketCustomerOut: {
/**
* Id
* Format: uuid
*/
id: string;
/** Email */
email?: string | null;
/** Full Name */
full_name?: string | null;
};
/** TicketDetailResponse */
TicketDetailResponse: {
ticket: components["schemas"]["TicketOut"];
/** Activities */
activities: components["schemas"]["TicketActivityOut"][];
/** Runs */
runs: components["schemas"]["InvestigationRunOut"][];
/** Linked Session Ids */
linked_session_ids: string[];
/**
* Possible Duplicates
* @default []
*/
possible_duplicates: components["schemas"]["TicketListItem"][];
/**
* Can Notify Customer
* @default false
*/
can_notify_customer: boolean;
};
/**
* TicketListItem
* @description Slim row for the list view.
*/
TicketListItem: {
/**
* Id
* Format: uuid
*/
id: string;
/** Ticket Number */
ticket_number: number;
/** Display Number */
display_number: string;
/** Title */
title: string;
status: components["schemas"]["TicketStatus"];
priority: components["schemas"]["TicketPriority"];
/** Tags */
tags?: string[] | null;
/** Assignee User Id */
assignee_user_id?: string | null;
/** Assignee Name */
assignee_name?: string | null;
/** Ai State */
ai_state?: string | null;
/** Sla Due At */
sla_due_at?: string | null;
/** Resolved At */
resolved_at?: string | null;
/** Created At */
created_at?: string | null;
/** Updated At */
updated_at?: string | null;
};
/** TicketListResponse */
TicketListResponse: {
/** Tickets */
tickets: components["schemas"]["TicketListItem"][];
pagination: components["schemas"]["Pagination"];
};
/** TicketOut */
TicketOut: {
/**
* Id
* Format: uuid
*/
id: string;
/** Ticket Number */
ticket_number: number;
/** Display Number */
display_number: string;
/**
* Organization Id
* Format: uuid
*/
organization_id: string;
/** Customer Id */
customer_id?: string | null;
/** Title */
title: string;
/** Original Title */
original_title?: string | null;
/** Description */
description?: string | null;
status: components["schemas"]["TicketStatus"];
priority: components["schemas"]["TicketPriority"];
/** Severity */
severity?: number | null;
source: components["schemas"]["TicketSource"];
/** Intent */
intent?: string | null;
/** Triage Confidence */
triage_confidence?: number | null;
/** Ai Summary */
ai_summary?: string | null;
/** Tags */
tags?: string[] | null;
/** Assignee User Id */
assignee_user_id?: string | null;
/** Group Id */
group_id?: string | null;
/** Agent Id */
agent_id?: string | null;
/** Duplicate Of Ticket Id */
duplicate_of_ticket_id?: string | null;
resolution_outcome?: components["schemas"]["ResolutionOutcome"] | null;
/** Resolution Summary */
resolution_summary?: string | null;
/** Customer Resolution Message */
customer_resolution_message?: string | null;
/** First Response At */
first_response_at?: string | null;
/** Resolved At */
resolved_at?: string | null;
/** Closed At */
closed_at?: string | null;
/** Confirmation Requested At */
confirmation_requested_at?: string | null;
/**
* Reopened Count
* @default 0
*/
reopened_count: number;
/** Csat Requested At */
csat_requested_at?: string | null;
/** Csat Score */
csat_score?: number | null;
/** Csat Responded At */
csat_responded_at?: string | null;
/** External Ref Type */
external_ref_type?: string | null;
/** External Ref Id */
external_ref_id?: string | null;
/** External Ref Url */
external_ref_url?: string | null;
/** Created By User Id */
created_by_user_id?: string | null;
/** Created At */
created_at?: string | null;
/** Updated At */
updated_at?: string | null;
/** Ai State */
ai_state?: string | null;
/** Sla Due At */
sla_due_at?: string | null;
assignee?: components["schemas"]["TicketUserOut"] | null;
customer?: components["schemas"]["TicketCustomerOut"] | null;
};
/**
* TicketPriority
* @enum {string}
*/
TicketPriority: "urgent" | "high" | "medium" | "low";
/** TicketReopen */
TicketReopen: {
/** Reason */
reason?: string | null;
};
/** TicketResolve */
TicketResolve: {
/** @default fixed */
outcome: components["schemas"]["ResolutionOutcome"];
/** Resolution Summary */
resolution_summary?: string | null;
/** Customer Message */
customer_message?: string | null;
};
/** TicketSettingsOut */
TicketSettingsOut: {
/** Autonomy Level */
autonomy_level: number;
/** Auto Investigate On Create */
auto_investigate_on_create: boolean;
/** Min Confidence To Auto Resolve */
min_confidence_to_auto_resolve: number;
/** Confirmation Timeout Hours */
confirmation_timeout_hours: number;
/** Csat Enabled */
csat_enabled: boolean;
/** Sla Targets */
sla_targets?: {
[key: string]: unknown;
} | null;
/** Created Template */
created_template?: string | null;
/** Resolved Template */
resolved_template?: string | null;
/** Jira Escalation Enabled */
jira_escalation_enabled: boolean;
/** Jira Escalation Priority */
jira_escalation_priority?: string | null;
/** Investigation Mcp Tool Ids */
investigation_mcp_tool_ids?: number[] | null;
/** Alert Webhook Enabled */
alert_webhook_enabled: boolean;
/** Alert Webhook Secret */
alert_webhook_secret?: string | null;
/** Max Tool Calls Per Run */
max_tool_calls_per_run: number;
/** Max Runs Per Ticket */
max_runs_per_ticket: number;
};
/** TicketSettingsUpdate */
TicketSettingsUpdate: {
/** Autonomy Level */
autonomy_level?: number | null;
/** Auto Investigate On Create */
auto_investigate_on_create?: boolean | null;
/** Min Confidence To Auto Resolve */
min_confidence_to_auto_resolve?: number | null;
/** Confirmation Timeout Hours */
confirmation_timeout_hours?: number | null;
/** Csat Enabled */
csat_enabled?: boolean | null;
/** Sla Targets */
sla_targets?: {
[key: string]: unknown;
} | null;
/** Created Template */
created_template?: string | null;
/** Resolved Template */
resolved_template?: string | null;
/** Jira Escalation Enabled */
jira_escalation_enabled?: boolean | null;
jira_escalation_priority?: components["schemas"]["TicketPriority"] | null;
/** Investigation Mcp Tool Ids */
investigation_mcp_tool_ids?: number[] | null;
/** Alert Webhook Enabled */
alert_webhook_enabled?: boolean | null;
/** Max Tool Calls Per Run */
max_tool_calls_per_run?: number | null;
/** Max Runs Per Ticket */
max_runs_per_ticket?: number | null;
};
/**
* TicketSource
* @enum {string}
*/
TicketSource: "chat_ai" | "human_agent" | "manual" | "api";
/** TicketStats */
TicketStats: {
/** Open */
open: number;
/** Awaiting Approval */
awaiting_approval: number;
/** Sla Breaching */
sla_breaching: number;
/** Ai Resolved Pct 7D */
ai_resolved_pct_7d?: number | null;
/** Csat Avg */
csat_avg?: number | null;
/** Csat Ai Avg */
csat_ai_avg?: number | null;
/** Csat Human Avg */
csat_human_avg?: number | null;
/**
* Csat Responses
* @default 0
*/
csat_responses: number;
/**
* Csat Window Days
* @default 30
*/
csat_window_days: number;
};
/**
* TicketStatus
* @enum {string}
*/
TicketStatus: "open" | "triaging" | "investigating" | "awaiting_approval" | "in_progress" | "resolved_pending_confirmation" | "resolved" | "closed" | "reopened";
/**
* TicketUpdate
* @description Partial update — omitted fields keep their current values (apply with
* model_dump(exclude_unset=True)).
*/
TicketUpdate: {
/** Title */
title?: string | null;
/** Description */
description?: string | null;
/** Customer Email */
customer_email?: string | null;
/** Customer Name */
customer_name?: string | null;
status?: components["schemas"]["TicketStatus"] | null;
priority?: components["schemas"]["TicketPriority"] | null;
/** Severity */
severity?: number | null;
/** Tags */
tags?: string[] | null;
/** Assignee User Id */
assignee_user_id?: string | null;
/** Group Id */
group_id?: string | null;
resolution_outcome?: components["schemas"]["ResolutionOutcome"] | null;
/** Resolution Summary */
resolution_summary?: string | null;
/** Customer Resolution Message */
customer_resolution_message?: string | null;
};
/** TicketUserOut */
TicketUserOut: {
/**
* Id
* Format: uuid
*/
id: string;
/** Full Name */
full_name?: string | null;
/** Email */
email?: string | null;
};
/** TimelineEntry */
TimelineEntry: {
/** Stage */
stage: string;
/**
* At
* Format: date-time
*/
at: string;
};
/**
* TokenData
* @description Token response data
*/
TokenData: {
/** Token */
token: string;
/** Widget Id */
widget_id: string;
/** Expires In */
expires_in: number;
/** Expires At */
expires_at: string;
/** Created At */
created_at: string;
};
/** TokenResponse */
TokenResponse: {
/** Access Token */
access_token: string;
/** Refresh Token */
refresh_token: string;
/** Token Type */
token_type: string;
user: components["schemas"]["UserResponse"];
};
/** UrlsRequest */
UrlsRequest: {
/**
* Org Id
* Format: uuid
*/
org_id: string;
/**
* Pdf Urls
* @default []
*/
pdf_urls: string[];
/**
* Websites
* @default []
*/
websites: string[];
/**
* Sitemaps
* @default []
*/
sitemaps: string[];
/** Agent Id */
agent_id?: string | null;
/** Max Links */
max_links?: number | null;
/** Crawl Scope */
crawl_scope?: string | null;
};
/** UserCreate */
UserCreate: {
/** See All Ai Chats */
see_all_ai_chats?: boolean | null;
/** See All Org Chats */
see_all_org_chats?: boolean | null;
/**
* Email
* Format: email
*/
email: string;
/** Full Name */
full_name: string;
/**
* Is Active
* @default true
*/
is_active: boolean;
/** Profile Pic */
profile_pic?: string | null;
/**
* Is Online
* @default false
*/
is_online: boolean;
/** Last Seen */
last_seen?: string | null;
/** Password */
password: string;
/** Role Id */
role_id: number;
};
/** UserGroupCreate */
UserGroupCreate: {
/** Name */
name: string;
/** Description */
description?: string | null;
};
/** UserGroupUpdate */
UserGroupUpdate: {
/** Name */
name?: string | null;
/** Description */
description?: string | null;
};
/** UserGroupWithUsers */
UserGroupWithUsers: {
/** Name */
name: string;
/** Description */
description?: string | null;
/**
* Id
* Format: uuid
*/
id: string;
/**
* Organization Id
* Format: uuid
*/
organization_id: string;
/** Users */
users: components["schemas"]["UserResponse"][];
};
/** UserResponse */
UserResponse: {
/**
* Email
* Format: email
*/
email: string;
/** Full Name */
full_name: string;
/** Is Active */
is_active?: boolean | null;
/** Profile Pic */
profile_pic?: string | null;
/** Is Online */
is_online?: boolean | null;
/** Last Seen */
last_seen?: string | null;
/**
* Id
* Format: uuid
*/
id: string;
/** Organization Id */
organization_id?: string | null;
/** Created At */
created_at?: string | null;
/** Updated At */
updated_at?: string | null;
/** Groups */
groups?: components["schemas"]["app__models__schemas__user__UserGroupResponse"][] | null;
role?: components["schemas"]["RoleResponse"] | null;
};
/** UserStatusUpdate */
UserStatusUpdate: {
/** Is Online */
is_online: boolean;
};
/** UserUpdate */
UserUpdate: {
/** See All Ai Chats */
see_all_ai_chats?: boolean | null;
/** See All Org Chats */
see_all_org_chats?: boolean | null;
/** Email */
email?: string | null;
/** Full Name */
full_name?: string | null;
/** Password */
password?: string | null;
/** Is Active */
is_active?: boolean | null;
/** Current Password */
current_password?: string | null;
/** Role Id */
role_id?: number | null;
/** Profile Pic */
profile_pic?: string | null;
/** Is Online */
is_online?: boolean | null;
};
/** ValidationError */
ValidationError: {
/** Location */
loc: (string | number)[];
/** Message */
msg: string;
/** Error Type */
type: string;
/** Input */
input?: unknown;
/** Context */
ctx?: Record<string, never>;
};
/**
* WhatsAppConnectRequest
* @description Manual WhatsApp Cloud API credentials, from the customer's own Meta app.
*/
WhatsAppConnectRequest: {
/** App Secret */
app_secret?: string | null;
/** Phone Number Id */
phone_number_id: string;
/** Access Token */
access_token: string;
/** Waba Id */
waba_id?: string | null;
/** Display Name */
display_name?: string | null;
};
/**
* WidgetAppCreate
* @description Schema for creating a new widget app
*/
WidgetAppCreate: {
/**
* Name
* @description App name (e.g., 'Production Widget')
*/
name: string;
/**
* Description
* @description Optional description
*/
description?: string | null;
};
/**
* WidgetAppListResponse
* @description Schema for list of widget apps
*/
WidgetAppListResponse: {
/** Total */
total: number;
/** Apps */
apps: components["schemas"]["WidgetAppResponse"][];
};
/**
* WidgetAppResponse
* @description Schema for widget app response (without API key)
*/
WidgetAppResponse: {
/**
* Name
* @description App name (e.g., 'Production Widget')
*/
name: string;
/**
* Description
* @description Optional description
*/
description?: string | null;
/**
* Id
* Format: uuid
*/
id: string;
/**
* Organization Id
* Format: uuid
*/
organization_id: string;
/**
* Created By
* Format: uuid
*/
created_by: string;
/** Is Active */
is_active: boolean;
/**
* Created At
* Format: date-time
*/
created_at: string;
/**
* Updated At
* Format: date-time
*/
updated_at: string;
};
/**
* WidgetAppUpdate
* @description Schema for updating widget app
*/
WidgetAppUpdate: {
/** Name */
name?: string | null;
/** Description */
description?: string | null;
/** Is Active */
is_active?: boolean | null;
};
/**
* WidgetAppWithKeyResponse
* @description Schema for newly created app (includes API key ONCE).
*
* IMPORTANT: Only use this for create/regenerate responses.
* Never log or persist the api_key field.
*/
WidgetAppWithKeyResponse: {
/**
* Name
* @description App name (e.g., 'Production Widget')
*/
name: string;
/**
* Description
* @description Optional description
*/
description?: string | null;
/**
* Id
* Format: uuid
*/
id: string;
/**
* Organization Id
* Format: uuid
*/
organization_id: string;
/**
* Created By
* Format: uuid
*/
created_by: string;
/** Is Active */
is_active: boolean;
/**
* Created At
* Format: date-time
*/
created_at: string;
/**
* Updated At
* Format: date-time
*/
updated_at: string;
/**
* Api Key
* @description API key - SAVE THIS! It won't be shown again.
*/
api_key: string;
};
/** WidgetCreate */
WidgetCreate: {
/** Name */
name: string;
/** Agent Id */
agent_id?: string | null;
};
/**
* WidgetPosition
* @enum {string}
*/
WidgetPosition: "FLOATING" | "FIXED";
/** WidgetResponse */
WidgetResponse: {
/** Id */
id: string;
/**
* Organization Id
* Format: uuid
*/
organization_id: string;
agent: components["schemas"]["AgentResponse"];
human_agent?: components["schemas"]["HumanAgentResponse"] | null;
/** Agent Id */
agent_id?: string | null;
/** Token */
token?: string | null;
};
/** WorkflowConnectionOperation */
WorkflowConnectionOperation: {
/**
* Operation
* @enum {string}
*/
operation: "create" | "update" | "delete";
/** Id */
id?: string | null;
/** Source Node Id */
source_node_id?: string | null;
/** Target Node Id */
target_node_id?: string | null;
/** Label */
label?: string | null;
/** Condition */
condition?: string | null;
/** Priority */
priority?: number | null;
/** Connection Metadata */
connection_metadata?: {
[key: string]: unknown;
} | null;
};
/** WorkflowConnectionResponse */
WorkflowConnectionResponse: {
/**
* Workflow Id
* Format: uuid
*/
workflow_id: string;
/**
* Source Node Id
* Format: uuid
*/
source_node_id: string;
/**
* Target Node Id
* Format: uuid
*/
target_node_id: string;
/** Label */
label?: string | null;
/** Condition */
condition?: string | null;
/**
* Priority
* @default 0
*/
priority: number;
/** Connection Metadata */
connection_metadata?: {
[key: string]: unknown;
};
/**
* Id
* Format: uuid
*/
id: string;
/**
* Created At
* Format: date-time
*/
created_at: string;
/**
* Updated At
* Format: date-time
*/
updated_at: string;
};
/** WorkflowCreate */
WorkflowCreate: {
/** Name */
name: string;
/** Description */
description?: string | null;
/** @default draft */
status: components["schemas"]["WorkflowStatus"] | null;
/**
* Is Template
* @default false
*/
is_template: boolean;
/**
* Default Language
* @default en
*/
default_language: string;
/** Canvas Data */
canvas_data?: {
[key: string]: unknown;
};
/** Settings */
settings?: {
[key: string]: unknown;
};
/**
* Agent Id
* Format: uuid
*/
agent_id: string;
};
/** WorkflowNodeOperation */
WorkflowNodeOperation: {
/**
* Operation
* @enum {string}
*/
operation: "create" | "update" | "delete";
/** Id */
id?: string | null;
node_type?: components["schemas"]["NodeType"] | null;
/** Name */
name?: string | null;
/** Description */
description?: string | null;
/** Position X */
position_x?: number | null;
/** Position Y */
position_y?: number | null;
/** Config */
config?: {
[key: string]: unknown;
} | null;
/** Landing Page Heading */
landing_page_heading?: string | null;
/** Landing Page Content */
landing_page_content?: string | null;
};
/** WorkflowNodeResponse */
WorkflowNodeResponse: {
/**
* Workflow Id
* Format: uuid
*/
workflow_id: string;
node_type: components["schemas"]["NodeType"];
/** Name */
name: string;
/** Description */
description?: string | null;
/**
* Position X
* @default 0
*/
position_x: number;
/**
* Position Y
* @default 0
*/
position_y: number;
/** Config */
config?: {
[key: string]: unknown;
};
/** Message Text */
message_text?: string | null;
/** Condition Expression */
condition_expression?: string | null;
action_type?: components["schemas"]["ActionType"] | null;
/** Action Config */
action_config?: {
[key: string]: unknown;
} | null;
/** Transfer Rules */
transfer_rules?: {
[key: string]: unknown;
} | null;
/** Wait Duration */
wait_duration?: number | null;
/** Wait Until Condition */
wait_until_condition?: string | null;
/** Landing Page Heading */
landing_page_heading?: string | null;
/** Landing Page Content */
landing_page_content?: string | null;
/**
* Id
* Format: uuid
*/
id: string;
/**
* Created At
* Format: date-time
*/
created_at: string;
/**
* Updated At
* Format: date-time
*/
updated_at: string;
};
/** WorkflowNodeUpdate */
WorkflowNodeUpdate: {
node_type?: components["schemas"]["NodeType"] | null;
/** Name */
name?: string | null;
/** Description */
description?: string | null;
/** Position X */
position_x?: number | null;
/** Position Y */
position_y?: number | null;
/** Config */
config?: {
[key: string]: unknown;
} | null;
/** Landing Page Heading */
landing_page_heading?: string | null;
/** Landing Page Content */
landing_page_content?: string | null;
};
/** WorkflowNodesResponse */
WorkflowNodesResponse: {
/** Nodes */
nodes: components["schemas"]["WorkflowNodeResponse"][];
/** Connections */
connections: components["schemas"]["WorkflowConnectionResponse"][];
};
/** WorkflowNodesUpdateRequest */
WorkflowNodesUpdateRequest: {
/** Nodes */
nodes: {
[key: string]: unknown;
}[];
/** Connections */
connections: {
[key: string]: unknown;
}[];
};
/** WorkflowResponse */
WorkflowResponse: {
/** Name */
name: string;
/** Description */
description?: string | null;
/** @default draft */
status: components["schemas"]["WorkflowStatus"] | null;
/**
* Is Template
* @default false
*/
is_template: boolean;
/**
* Default Language
* @default en
*/
default_language: string;
/** Canvas Data */
canvas_data?: {
[key: string]: unknown;
};
/** Settings */
settings?: {
[key: string]: unknown;
};
/**
* Id
* Format: uuid
*/
id: string;
/**
* Organization Id
* Format: uuid
*/
organization_id: string;
/**
* Agent Id
* Format: uuid
*/
agent_id: string;
/**
* Created By
* Format: uuid
*/
created_by: string;
/**
* Created At
* Format: date-time
*/
created_at: string;
/**
* Updated At
* Format: date-time
*/
updated_at: string;
};
/**
* WorkflowStatus
* @enum {string}
*/
WorkflowStatus: "draft" | "published" | "archived";
/** WorkflowUpdate */
WorkflowUpdate: {
/** Name */
name?: string | null;
/** Description */
description?: string | null;
status?: components["schemas"]["WorkflowStatus"] | null;
/** Is Template */
is_template?: boolean | null;
/** Default Language */
default_language?: string | null;
/** Canvas Data */
canvas_data?: {
[key: string]: unknown;
} | null;
/** Settings */
settings?: {
[key: string]: unknown;
} | null;
/** Agent Id */
agent_id?: string | null;
/** Nodes */
nodes?: components["schemas"]["WorkflowNodeOperation"][] | null;
/** Connections */
connections?: components["schemas"]["WorkflowConnectionOperation"][] | null;
};
/** UserGroupResponse */
app__models__schemas__user__UserGroupResponse: {
/** Name */
name: string;
/** Description */
description?: string | null;
};
/** UserGroupResponse */
app__models__schemas__user_group__UserGroupResponse: {
/** Name */
name: string;
/** Description */
description?: string | null;
/**
* Id
* Format: uuid
*/
id: string;
/**
* Organization Id
* Format: uuid
*/
organization_id: string;
};
};
responses: never;
parameters: never;
requestBodies: never;
headers: never;
pathItems: never;
}
export type $defs = Record<string, never>;
export interface operations {
get_chat_history_api_v1_chats__get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
get_recent_chats_api_v1_chats_recent_get: {
parameters: {
query?: {
skip?: number;
limit?: number;
agent_id?: string | null;
/** @description Filter by status: 'open', 'closed', or 'transferred' */
status?: string | null;
/** @description Filter by user name */
user_name?: string | null;
/** @description Filter by specific user ID */
user_id?: string | null;
/** @description Filter by customer email */
customer_email?: string | null;
/** @description Filter conversations from this date */
date_from?: string | null;
/** @description Filter conversations to this date */
date_to?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ChatOverviewResponse"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_recent_chats_api_v1_chats_recent_shopify_get: {
parameters: {
query?: {
skip?: number;
limit?: number;
agent_id?: string | null;
/** @description Filter by status: 'open', 'closed', or 'transferred' */
status?: string | null;
/** @description Filter by user name */
user_name?: string | null;
/** @description Filter by specific user ID */
user_id?: string | null;
/** @description Filter by customer email */
customer_email?: string | null;
/** @description Filter conversations from this date */
date_from?: string | null;
/** @description Filter conversations to this date */
date_to?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ChatOverviewResponse"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_chat_detail_api_v1_chats__session_id__get: {
parameters: {
query?: never;
header?: never;
path: {
session_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ChatDetailResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_chat_detail_api_v1_chats__session_id__shopify_get: {
parameters: {
query?: never;
header?: never;
path: {
session_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ChatDetailResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_channel_accounts_api_v1_channels_accounts_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ChannelAccountOut"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
connect_telegram_api_v1_channels_telegram_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["TelegramConnectRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ChannelAccountOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
disconnect_telegram_api_v1_channels_telegram__account_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
account_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_embedded_signup_config_api_v1_channels_meta_embedded_signup_config_get: {
parameters: {
query?: {
channel?: string;
};
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["EmbeddedSignupConfigOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
connect_whatsapp_api_v1_channels_meta_whatsapp_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["WhatsAppConnectRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ChannelAccountOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
connect_whatsapp_embedded_signup_api_v1_channels_meta_whatsapp_embedded_signup_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["EmbeddedSignupRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ChannelAccountOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
connect_messenger_api_v1_channels_meta_messenger_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["MessengerConnectRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ChannelAccountOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_messenger_signup_pages_api_v1_channels_meta_messenger_signup_pages_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["MessengerSignupRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["MessengerSignupPagesOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
connect_messenger_signup_api_v1_channels_meta_messenger_signup_connect_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["MessengerSignupConnectRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ChannelAccountOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
connect_instagram_login_api_v1_channels_meta_instagram_login_connect_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["InstagramLoginRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ChannelAccountOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
connect_instagram_api_v1_channels_meta_instagram_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["InstagramConnectRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ChannelAccountOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
disconnect_meta_account_api_v1_channels_meta__account_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
account_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
start_whatsapp_conversation_api_v1_channels_meta_whatsapp__account_id__conversations_post: {
parameters: {
query?: never;
header?: never;
path: {
account_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["OutboundConversationRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["OutboundConversationOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
send_whatsapp_template_api_v1_channels_meta_whatsapp__account_id__send_template_post: {
parameters: {
query?: never;
header?: never;
path: {
account_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["TemplateSendRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_whatsapp_templates_api_v1_channels_meta_whatsapp__account_id__templates_get: {
parameters: {
query?: never;
header?: never;
path: {
account_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TemplateOut"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_whatsapp_template_library_api_v1_channels_meta_whatsapp__account_id__template_library_get: {
parameters: {
query?: never;
header?: never;
path: {
account_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TemplateLibraryOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
install_slack_api_v1_channels_slack_install_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
slack_oauth_callback_api_v1_channels_slack_callback_get: {
parameters: {
query?: {
code?: string;
state?: string;
error?: string;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
disconnect_slack_api_v1_channels_slack__account_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
account_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
connect_email_api_v1_channels_email_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["EmailConnectRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ChannelAccountOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_email_webhook_url_api_v1_channels_email__account_id__webhook_url_get: {
parameters: {
query?: never;
header?: never;
path: {
account_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
disconnect_email_api_v1_channels_email__account_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
account_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_sms_providers_api_v1_channels_sms_providers_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SmsProviderInfo"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
connect_sms_api_v1_channels_sms_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["SmsConnectRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ChannelAccountOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
disconnect_sms_api_v1_channels_sms__account_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
account_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
connect_line_api_v1_channels_line_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["LineConnectRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ChannelAccountOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
disconnect_line_api_v1_channels_line__account_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
account_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
set_account_agent_api_v1_channels_agent_config__account_id__post: {
parameters: {
query?: never;
header?: never;
path: {
account_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["AgentChannelConfigRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ChannelAccountOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
clear_account_agent_api_v1_channels_agent_config__account_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
account_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_tickets_api_v1_tickets_get: {
parameters: {
query?: {
status?: string | null;
priority?: string | null;
assignee_id?: string | null;
unassigned?: boolean;
ai_state?: string | null;
search?: string | null;
sort?: string;
page?: number;
page_size?: number;
};
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TicketListResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
create_ticket_api_v1_tickets_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["TicketCreate"];
};
};
responses: {
/** @description Successful Response */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TicketDetailResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
ticket_stats_api_v1_tickets_stats_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TicketStats"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_settings_api_v1_tickets_settings_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TicketSettingsOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_settings_api_v1_tickets_settings_put: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["TicketSettingsUpdate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TicketSettingsOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_ticket_by_session_api_v1_tickets_by_session__session_id__get: {
parameters: {
query?: never;
header?: never;
path: {
session_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TicketOut"] | null;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
draft_from_session_api_v1_tickets_draft_from_session__session_id__get: {
parameters: {
query?: never;
header?: never;
path: {
session_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_ticket_api_v1_tickets__ticket_id__get: {
parameters: {
query?: never;
header?: never;
path: {
ticket_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TicketDetailResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_ticket_api_v1_tickets__ticket_id__patch: {
parameters: {
query?: never;
header?: never;
path: {
ticket_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["TicketUpdate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TicketOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
add_comment_api_v1_tickets__ticket_id__comments_post: {
parameters: {
query?: never;
header?: never;
path: {
ticket_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["TicketCommentCreate"];
};
};
responses: {
/** @description Successful Response */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TicketActivityOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
resolve_ticket_api_v1_tickets__ticket_id__resolve_post: {
parameters: {
query?: never;
header?: never;
path: {
ticket_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["TicketResolve"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TicketOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
reopen_ticket_api_v1_tickets__ticket_id__reopen_post: {
parameters: {
query?: never;
header?: never;
path: {
ticket_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["TicketReopen"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TicketOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
investigate_ticket_api_v1_tickets__ticket_id__investigate_post: {
parameters: {
query?: never;
header?: never;
path: {
ticket_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: {
content: {
"application/json": components["schemas"]["InvestigateRequest"] | null;
};
};
responses: {
/** @description Successful Response */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["InvestigationRunOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_investigation_api_v1_tickets__ticket_id__investigation_get: {
parameters: {
query?: {
run_id?: string | null;
};
header?: never;
path: {
ticket_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["InvestigationDetailResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
approve_proposal_api_v1_tickets__ticket_id__proposal_approve_post: {
parameters: {
query?: never;
header?: never;
path: {
ticket_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ProposalOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
reject_proposal_api_v1_tickets__ticket_id__proposal_reject_post: {
parameters: {
query?: never;
header?: never;
path: {
ticket_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["ProposalRejectRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ProposalOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_rca_api_v1_tickets__ticket_id__rca_patch: {
parameters: {
query?: never;
header?: never;
path: {
ticket_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["RcaUpdate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["RCADocumentOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
send_rca_to_customer_api_v1_tickets__ticket_id__rca_send_customer_post: {
parameters: {
query?: never;
header?: never;
path: {
ticket_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TicketActivityOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_connections_api_v1_crm_connections_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CrmConnectionOut"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
install_crm_api_v1_crm__provider__install_get: {
parameters: {
query?: never;
header?: never;
path: {
provider: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
crm_oauth_callback_api_v1_crm__provider__callback_get: {
parameters: {
query?: {
code?: string;
state?: string;
error?: string;
};
header?: never;
path: {
provider: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
test_crm_connection_api_v1_crm__provider__test_post: {
parameters: {
query?: never;
header?: never;
path: {
provider: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CrmTestResult"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
disconnect_crm_api_v1_crm__provider__delete: {
parameters: {
query?: never;
header?: never;
path: {
provider: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
hubspot_uninstall_webhook_api_v1_crm_hubspot_uninstall_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
pipedrive_uninstall_webhook_api_v1_crm_pipedrive_uninstall_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
list_connectors_api_v1_ticket_db_connectors_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["DBConnectorOut"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
create_connector_api_v1_ticket_db_connectors_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["DBConnectorCreate"];
};
};
responses: {
/** @description Successful Response */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["DBConnectorOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
discover_tables_api_v1_ticket_db_connectors_discover_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["DBConnectorDiscoverRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["DBConnectorDiscoverResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_connector_api_v1_ticket_db_connectors__connector_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
connector_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
204: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_connector_api_v1_ticket_db_connectors__connector_id__patch: {
parameters: {
query?: never;
header?: never;
path: {
connector_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["DBConnectorUpdate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["DBConnectorOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
test_saved_connector_api_v1_ticket_db_connectors__connector_id__test_post: {
parameters: {
query?: never;
header?: never;
path: {
connector_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["DBConnectorDiscoverResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
alert_intake_api_v1_tickets_webhooks_alerts__org_id___secret__post: {
parameters: {
query?: never;
header?: never;
path: {
org_id: string;
secret: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
[key: string]: unknown;
};
};
};
responses: {
/** @description Successful Response */
202: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
telegram_webhook_api_v1_webhooks_telegram__account_id__post: {
parameters: {
query?: never;
header?: never;
path: {
account_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
slack_webhook_api_v1_webhooks_slack_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
email_webhook_api_v1_webhooks_email__account_id__post: {
parameters: {
query?: {
token?: string;
};
header?: never;
path: {
account_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
sms_webhook_api_v1_webhooks_sms__provider___account_id__post: {
parameters: {
query?: {
token?: string;
};
header?: never;
path: {
provider: string;
account_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
line_webhook_api_v1_webhooks_line__account_id__post: {
parameters: {
query?: never;
header?: never;
path: {
account_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
meta_webhook_verify_api_v1_webhooks_meta_get: {
parameters: {
query?: {
"hub.mode"?: string;
"hub.verify_token"?: string;
"hub.challenge"?: string;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
meta_webhook_api_v1_webhooks_meta_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
own_app_webhook_verify_api_v1_webhooks_meta__account_id__get: {
parameters: {
query?: {
"hub.mode"?: string;
"hub.verify_token"?: string;
"hub.challenge"?: string;
};
header?: never;
path: {
account_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
own_app_webhook_api_v1_webhooks_meta__account_id__post: {
parameters: {
query?: never;
header?: never;
path: {
account_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
create_organization_api_v1_organizations_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["OrganizationCreate"];
};
};
responses: {
/** @description Successful Response */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["OrganizationCreateResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
is_organization_setup_api_v1_organizations_setup_status_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
[key: string]: unknown;
};
};
};
};
};
check_domain_availability_api_v1_organizations_check_domain__domain__get: {
parameters: {
query?: never;
header?: never;
path: {
domain: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_organization_api_v1_organizations__org_id__get: {
parameters: {
query?: never;
header?: never;
path: {
org_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["OrganizationResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_organization_api_v1_organizations__org_id__patch: {
parameters: {
query?: never;
header?: never;
path: {
org_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["OrganizationUpdate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["OrganizationResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_organization_stats_api_v1_organizations__org_id__stats_get: {
parameters: {
query?: never;
header?: never;
path: {
org_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_users_api_v1_users_get: {
parameters: {
query?: {
skip?: number;
limit?: number;
};
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["UserResponse"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
create_user_api_v1_users_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["UserCreate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["UserResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_team_overview_api_v1_users_team_overview_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TeamOverviewResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_teammates_api_v1_users_teammates_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TeammateResponse"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_my_avatar_api_v1_users_me_avatar_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_user_api_v1_users__user_id__get: {
parameters: {
query?: never;
header?: never;
path: {
user_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["UserResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_user_api_v1_users__user_id__put: {
parameters: {
query?: never;
header?: never;
path: {
user_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["UserUpdate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["UserResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_user_api_v1_users__user_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
user_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
204: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
login_api_v1_users_login_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/x-www-form-urlencoded": components["schemas"]["Body_login_api_v1_users_login_post"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TokenResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
refresh_token_api_v1_users_refresh_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TokenResponse"];
};
};
};
};
logout_api_v1_users_logout_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
register_fcm_token_api_v1_users_token_fcm_token_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["FCMTokenUpdate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
unregister_fcm_token_api_v1_users_token_fcm_token_delete: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["FCMTokenUpdate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_profile_api_v1_users_me_patch: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["UserUpdate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["UserResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
reset_user_password_api_v1_users__user_id__reset_password_post: {
parameters: {
query?: never;
header?: never;
path: {
user_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["AdminPasswordReset"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_user_status_api_v1_users__user_id__status_post: {
parameters: {
query?: never;
header?: never;
path: {
user_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["UserStatusUpdate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
upload_profile_pic_api_v1_users_me_profile_pic_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"multipart/form-data": components["schemas"]["Body_upload_profile_pic_api_v1_users_me_profile_pic_post"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["UserResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_profile_pic_api_v1_users_me_profile_pic_delete: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["UserResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_settings_api_v1_help_center_settings_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HelpCenterSettingsResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_settings_api_v1_help_center_settings_put: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["HelpCenterSettingsUpdate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HelpCenterSettingsResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
upload_logo_api_v1_help_center_logo_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"multipart/form-data": components["schemas"]["Body_upload_logo_api_v1_help_center_logo_post"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HelpCenterSettingsResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
remove_logo_api_v1_help_center_logo_delete: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HelpCenterSettingsResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
upload_favicon_api_v1_help_center_favicon_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"multipart/form-data": components["schemas"]["Body_upload_favicon_api_v1_help_center_favicon_post"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HelpCenterSettingsResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
remove_favicon_api_v1_help_center_favicon_delete: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HelpCenterSettingsResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_faqs_api_v1_help_center_faqs_get: {
parameters: {
query?: {
status?: components["schemas"]["FAQStatus"] | null;
category?: string | null;
q?: string | null;
page?: number;
page_size?: number;
};
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["FAQListResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
create_faq_api_v1_help_center_faqs_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["FAQCreate"];
};
};
responses: {
/** @description Successful Response */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["FAQResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_categories_api_v1_help_center_faqs_categories_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": string[];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
upload_faq_image_api_v1_help_center_faqs_image_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"multipart/form-data": components["schemas"]["Body_upload_faq_image_api_v1_help_center_faqs_image_post"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_faq_api_v1_help_center_faqs__faq_id__put: {
parameters: {
query?: never;
header?: never;
path: {
faq_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["FAQUpdate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["FAQResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_faq_api_v1_help_center_faqs__faq_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
faq_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
204: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
bulk_set_status_api_v1_help_center_faqs_bulk_status_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["FAQBulkStatusRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
bulk_delete_api_v1_help_center_faqs_bulk_delete_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["FAQBulkDeleteRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
generation_estimate_api_v1_help_center_generate_estimate_get: {
parameters: {
query?: {
/** @description False skips the per-source page scan — cheap counts for button labels */
include_pages?: boolean;
};
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["GenerationEstimateResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
start_generation_api_v1_help_center_generate_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: {
content: {
"application/json": components["schemas"]["GenerateRequest"] | null;
};
};
responses: {
/** @description Successful Response */
202: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["GenerationJobResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
start_import_api_v1_help_center_import_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["ImportRequest"];
};
};
responses: {
/** @description Successful Response */
202: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["GenerationJobResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
start_pdf_import_api_v1_help_center_import_pdf_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"multipart/form-data": components["schemas"]["Body_start_pdf_import_api_v1_help_center_import_pdf_post"];
};
};
responses: {
/** @description Successful Response */
202: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["GenerationJobResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_job_api_v1_help_center_jobs_get: {
parameters: {
query?: {
/** @description Active job only; false = most recent job */
active?: boolean;
};
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["GenerationJobResponse"] | null;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_job_by_id_api_v1_help_center_jobs__job_id__get: {
parameters: {
query?: never;
header?: never;
path: {
job_id: number;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["GenerationJobResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
set_domain_api_v1_help_center_domain_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["DomainRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["DomainStatusResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
remove_domain_api_v1_help_center_domain_delete: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["DomainStatusResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
verify_domain_api_v1_help_center_domain_verify_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["DomainStatusResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
domain_status_api_v1_help_center_domain_status_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["DomainStatusResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
upload_pdf_files_api_v1_knowledge_upload_pdf_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"multipart/form-data": components["schemas"]["Body_upload_pdf_files_api_v1_knowledge_upload_pdf_post"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_explore_progress_api_v1_knowledge_explore_progress__queue_id__get: {
parameters: {
query?: never;
header?: never;
path: {
queue_id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
add_urls_api_v1_knowledge_add_urls_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["UrlsRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
add_text_source_api_v1_knowledge_add_text_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["TextSourceRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
link_knowledge_to_agent_api_v1_knowledge_link_post: {
parameters: {
query: {
knowledge_id: number;
agent_id: string;
};
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
unlink_knowledge_from_agent_api_v1_knowledge_unlink_delete: {
parameters: {
query: {
knowledge_id: number;
agent_id: string;
};
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_knowledge_by_agent_api_v1_knowledge_agent__agent_id__get: {
parameters: {
query?: {
page?: number;
page_size?: number;
};
header?: never;
path: {
agent_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_agent_queue_items_api_v1_knowledge_queue_agent__agent_id__get: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_organization_queue_items_api_v1_knowledge_queue_organization__org_id__get: {
parameters: {
query?: never;
header?: never;
path: {
org_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_queue_status_api_v1_knowledge_queue__queue_id__get: {
parameters: {
query?: never;
header?: never;
path: {
queue_id: number;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_queue_item_api_v1_knowledge_queue__queue_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
queue_id: number;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_knowledge_by_organization_api_v1_knowledge_organization__org_id__get: {
parameters: {
query?: {
page?: number;
page_size?: number;
};
header?: never;
path: {
org_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_processor_status_api_v1_knowledge_processor_status_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_knowledge_api_v1_knowledge__knowledge_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
knowledge_id: number;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_knowledge_content_api_v1_knowledge__knowledge_id__content_get: {
parameters: {
query?: never;
header?: never;
path: {
knowledge_id: number;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_chunk_content_api_v1_knowledge__knowledge_id__chunk__chunk_id__put: {
parameters: {
query?: never;
header?: never;
path: {
knowledge_id: number;
chunk_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["Body_update_chunk_content_api_v1_knowledge__knowledge_id__chunk__chunk_id__put"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_chunk_api_v1_knowledge__knowledge_id__chunk__chunk_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
knowledge_id: number;
chunk_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
add_subpage_api_v1_knowledge__knowledge_id__subpage_post: {
parameters: {
query?: never;
header?: never;
path: {
knowledge_id: number;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["Body_add_subpage_api_v1_knowledge__knowledge_id__subpage_post"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_page_content_api_v1_knowledge__knowledge_id__page__page_id__put: {
parameters: {
query?: never;
header?: never;
path: {
knowledge_id: number;
page_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["Body_update_page_content_api_v1_knowledge__knowledge_id__page__page_id__put"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_page_api_v1_knowledge__knowledge_id__page__page_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
knowledge_id: number;
page_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_providers_api_v1_ai_providers_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
setup_ai_api_v1_ai_setup_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["AIConfigCreate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AISetupResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_organization_ai_config_api_v1_ai_config_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AIConfigResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_ai_config_api_v1_ai_config_put: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["AIConfigUpdate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AISetupResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
create_agent_api_v1_agent_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["AgentCreate"];
};
};
responses: {
/** @description Successful Response */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AgentWithCustomizationResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_agent_by_id_api_v1_agent__agent_id__get: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AgentWithCustomizationResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_agent_api_v1_agent__agent_id__put: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["AgentUpdate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AgentWithCustomizationResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_agent_by_id_api_v1_agent__agent_id__shopify_get: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AgentWithCustomizationResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_agent_api_v1_agent__agent_id__shopify_put: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["AgentUpdate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AgentWithCustomizationResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_agent_roster_api_v1_agent_roster_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AgentRosterItem"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_guardrail_default_api_v1_agent_guardrail_default_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
get_organization_agents_api_v1_agent_list_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AgentWithCustomizationResponse"][];
};
};
};
};
get_organization_agents_api_v1_agent_list_shopify_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AgentWithCustomizationResponse"][];
};
};
};
};
create_agent_customization_api_v1_agent__agent_id__customization_post: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CustomizationCreate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CustomizationResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
create_agent_customization_api_v1_agent__agent_id__customization_shopify_post: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CustomizationCreate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CustomizationResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
upload_agent_photo_api_v1_agent__agent_id__customization_photo_post: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"multipart/form-data": components["schemas"]["Body_upload_agent_photo_api_v1_agent__agent_id__customization_photo_post"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CustomizationResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
upload_agent_photo_api_v1_agent__agent_id__customization_photo_shopify_post: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"multipart/form-data": components["schemas"]["Body_upload_agent_photo_api_v1_agent__agent_id__customization_photo_shopify_post"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CustomizationResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_agent_groups_api_v1_agent__agent_id__groups_put: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": string[];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AgentWithCustomizationResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
generate_instructions_api_v1_agent_generate_instructions_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["InstructionPrompt"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": string[];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_lead_capture_config_api_v1_agent__agent_id__lead_capture_get: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LeadCaptureConfigResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_lead_capture_config_api_v1_agent__agent_id__lead_capture_put: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["LeadCaptureConfigUpdate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LeadCaptureConfigResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_people_api_v1_people_get: {
parameters: {
query?: {
stage?: string | null;
search?: string | null;
page?: number;
page_size?: number;
view?: string;
};
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PeopleListResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
people_stats_api_v1_people_stats_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PeopleStats"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_person_api_v1_people__customer_id__get: {
parameters: {
query?: never;
header?: never;
path: {
customer_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PersonDetail"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_person_api_v1_people__customer_id__patch: {
parameters: {
query?: never;
header?: never;
path: {
customer_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["PersonUpdateRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PersonDetail"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
mark_as_customer_api_v1_people__customer_id__mark_customer_post: {
parameters: {
query?: never;
header?: never;
path: {
customer_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PersonDetail"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_person_crm_api_v1_people__customer_id__crm_get: {
parameters: {
query?: never;
header?: never;
path: {
customer_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PersonCrmStatus"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
sync_person_crm_api_v1_people__customer_id__crm_sync_post: {
parameters: {
query?: never;
header?: never;
path: {
customer_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PersonCrmStatus"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_organization_mcp_tools_api_v1_mcp_tools_get: {
parameters: {
query?: {
enabled_only?: boolean;
};
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["MCPToolResponse"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
create_mcp_tool_api_v1_mcp_tools_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["MCPToolCreate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["MCPToolResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_mcp_tool_api_v1_mcp_tools__mcp_tool_id__get: {
parameters: {
query?: never;
header?: never;
path: {
mcp_tool_id: number;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["MCPToolResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_mcp_tool_api_v1_mcp_tools__mcp_tool_id__put: {
parameters: {
query?: never;
header?: never;
path: {
mcp_tool_id: number;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["MCPToolUpdate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["MCPToolResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_mcp_tool_api_v1_mcp_tools__mcp_tool_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
mcp_tool_id: number;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
test_mcp_tool_api_v1_mcp_tools__mcp_tool_id__test_post: {
parameters: {
query?: never;
header?: never;
path: {
mcp_tool_id: number;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["MCPToolTestResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_mcp_tool_references_api_v1_mcp_tools__mcp_tool_id__references_get: {
parameters: {
query?: never;
header?: never;
path: {
mcp_tool_id: number;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["MCPToolReferencesResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
add_mcp_tool_to_agent_api_v1_mcp_tools_agent_association_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["MCPToolToAgentCreate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["MCPToolToAgentResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
remove_mcp_tool_from_agent_api_v1_mcp_tools_agent_association__mcp_tool_id___agent_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
mcp_tool_id: number;
agent_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_agent_mcp_tools_api_v1_mcp_tools_agent__agent_id__get: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AgentMCPToolsResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_notifications_api_v1_notifications_get: {
parameters: {
query?: {
skip?: number;
limit?: number;
};
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["NotificationResponse"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
clear_notifications_api_v1_notifications_delete: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
mark_as_read_api_v1_notifications__notification_id__read_patch: {
parameters: {
query?: never;
header?: never;
path: {
notification_id: number;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
mark_all_as_read_api_v1_notifications_read_all_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_notification_api_v1_notifications__notification_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
notification_id: number;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_unread_count_api_v1_notifications_unread_count_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_notification_settings_api_v1_notifications_settings_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["NotificationSettingsOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_notification_settings_api_v1_notifications_settings_put: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["NotificationSettingsUpdate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["NotificationSettingsOut"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
send_test_notification_api_v1_notifications_test_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_widgets_api_v1_widgets_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["WidgetResponse"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
create_new_widget_api_v1_widgets_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["WidgetCreate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["WidgetResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_widget_ui_api_v1_widgets__widget_id__data_get: {
parameters: {
query?: {
source?: string | null;
};
header?: {
authorization?: string | null;
};
path: {
widget_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"text/html": string;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_widget_data_api_v1_widgets__widget_id__get: {
parameters: {
query?: {
email?: string | null;
source?: string | null;
};
header?: {
authorization?: string | null;
};
path: {
widget_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["WidgetResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
remove_widget_api_v1_widgets__widget_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
widget_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
end_chat_acknowledgment_api_v1_widgets__widget_id__end_chat_post: {
parameters: {
query: {
session_id: string;
reason?: string | null;
description?: string | null;
};
header?: {
authorization?: string | null;
};
path: {
widget_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_widgets_by_agent_api_v1_widgets_agent__agent_id__get: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["WidgetResponse"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_groups_api_v1_groups_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["UserGroupWithUsers"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
create_group_api_v1_groups_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["UserGroupCreate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["app__models__schemas__user_group__UserGroupResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_group_api_v1_groups__group_id__get: {
parameters: {
query?: never;
header?: never;
path: {
group_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["UserGroupWithUsers"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_group_api_v1_groups__group_id__put: {
parameters: {
query?: never;
header?: never;
path: {
group_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["UserGroupUpdate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["app__models__schemas__user_group__UserGroupResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_group_api_v1_groups__group_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
group_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
204: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
add_user_to_group_api_v1_groups__group_id__users__user_id__post: {
parameters: {
query?: never;
header?: never;
path: {
group_id: string;
user_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
remove_user_from_group_api_v1_groups__group_id__users__user_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
group_id: string;
user_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_roles_api_v1_roles_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["RoleResponse"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
create_role_api_v1_roles_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["RoleCreate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["RoleResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_role_api_v1_roles__role_id__get: {
parameters: {
query?: never;
header?: never;
path: {
role_id: number;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["RoleResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_role_api_v1_roles__role_id__put: {
parameters: {
query?: never;
header?: never;
path: {
role_id: number;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["RoleUpdate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["RoleResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_role_api_v1_roles__role_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
role_id: number;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
204: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
add_role_permission_api_v1_roles__role_id__permissions__permission__post: {
parameters: {
query?: never;
header?: never;
path: {
role_id: number;
permission: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
remove_role_permission_api_v1_roles__role_id__permissions__permission__delete: {
parameters: {
query?: never;
header?: never;
path: {
role_id: number;
permission: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_permissions_api_v1_roles_permissions_all_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PermissionResponse"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
takeover_chat_api_v1_sessions__session_id__takeover_post: {
parameters: {
query?: never;
header?: never;
path: {
session_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ChatDetailResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
route_chat_to_human_api_v1_sessions__session_id__route_to_human_post: {
parameters: {
query?: never;
header?: never;
path: {
session_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ChatDetailResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
reassign_chat_api_v1_sessions__session_id__reassign_post: {
parameters: {
query: {
to_user_id: string;
};
header?: never;
path: {
session_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ChatDetailResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_agent_performance_api_v1_analytics_agent_performance_get: {
parameters: {
query?: {
time_range?: string;
};
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_analytics_api_v1_analytics_get: {
parameters: {
query?: {
time_range?: string;
};
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_customer_analytics_api_v1_analytics_customer_analytics_get: {
parameters: {
query?: {
time_range?: string;
/** @description Page number */
page?: number;
/** @description Items per page */
page_size?: number;
};
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_customer_details_api_v1_analytics_customer_details__customer_id__get: {
parameters: {
query?: {
time_range?: string;
};
header?: never;
path: {
customer_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_sentiment_analytics_api_v1_analytics_sentiment_get: {
parameters: {
query?: {
time_range?: string;
};
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_session_sentiment_api_v1_analytics_session_sentiment__session_id__get: {
parameters: {
query?: never;
header?: never;
path: {
session_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
jira_status_api_v1_jira_status_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
disconnect_jira_api_v1_jira_disconnect_delete: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
authorize_jira_api_v1_jira_authorize_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
jira_oauth_callback_api_v1_jira_callback_get: {
parameters: {
query?: {
code?: string | null;
state?: string | null;
error?: string | null;
error_description?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
refresh_jira_token_api_v1_jira_refresh_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_jira_projects_api_v1_jira_projects_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["JiraProject"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_jira_issue_types_api_v1_jira_projects__project_key__issue_types_get: {
parameters: {
query?: never;
header?: never;
path: {
project_key: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["JiraIssueType"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_jira_priorities_api_v1_jira_priorities_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["JiraPriority"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
check_priority_availability_api_v1_jira_projects__project_key__issue_types__issue_type_id__has_priority_get: {
parameters: {
query?: never;
header?: never;
path: {
project_key: string;
issue_type_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
create_jira_issue_api_v1_jira_issues_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateJiraIssueModel"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_agent_jira_config_api_v1_jira_agent_config__agent_id__get: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
save_agent_jira_config_api_v1_jira_agent_config__agent_id__post: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["AgentJiraConfigModel"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
generate_widget_token_api_v1_generate_token_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["GenerateTokenRequest"];
};
};
responses: {
/** @description Successful Response */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["GenerateTokenResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
refresh_widget_token_api_v1_refresh_token_post: {
parameters: {
query?: never;
header?: {
authorization?: string | null;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["RefreshTokenRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["GenerateTokenResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
verify_widget_token_api_v1_verify_token_post: {
parameters: {
query: {
token: string;
widget_id: string;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
revoke_widget_token_api_v1_revoke_token_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["RevokeTokenRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["RevokeTokenResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_widget_apps_api_v1_widget_apps_get: {
parameters: {
query?: {
include_inactive?: boolean;
};
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["WidgetAppListResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
create_widget_app_api_v1_widget_apps_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["WidgetAppCreate"];
};
};
responses: {
/** @description Successful Response */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["WidgetAppWithKeyResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_widget_app_api_v1_widget_apps__app_id__get: {
parameters: {
query?: never;
header?: never;
path: {
app_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["WidgetAppResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_widget_app_api_v1_widget_apps__app_id__delete: {
parameters: {
query?: {
hard_delete?: boolean;
};
header?: never;
path: {
app_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
204: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_widget_app_api_v1_widget_apps__app_id__patch: {
parameters: {
query?: never;
header?: never;
path: {
app_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["WidgetAppUpdate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["WidgetAppResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
regenerate_api_key_api_v1_widget_apps__app_id__regenerate_key_post: {
parameters: {
query?: never;
header?: never;
path: {
app_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["WidgetAppWithKeyResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
exchange_session_token_api_v1_shopify_exchange_token_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
link_shop_to_org_api_v1_shopify_link_organization_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_shops_api_v1_shopify_shops_get: {
parameters: {
query?: {
skip?: number;
limit?: number;
};
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ShopifyShop"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_shop_api_v1_shopify_shops__shop_id__get: {
parameters: {
query?: never;
header?: never;
path: {
shop_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ShopifyShop"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_shop_api_v1_shopify_shops__shop_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
shop_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
link_shop_to_organization_api_v1_shopify_link_shop__shop_id__post: {
parameters: {
query?: never;
header?: never;
path: {
shop_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
check_connection_api_v1_shopify_status_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_shop_config_status_api_v1_shopify_shop_config_status_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
get_organization_domain_api_v1_shopify_organization_domain_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
update_organization_domain_api_v1_shopify_update_domain_put: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
get_connected_agents_api_v1_shopify_connected_agents_get: {
parameters: {
query: {
/** @description Shop ID */
shop_id: string;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_agent_shopify_config_api_v1_shopify_agent_config__agent_id__get: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AgentShopifyConfig"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
save_agent_shopify_config_api_v1_shopify_agent_config__agent_id__post: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["AgentShopifyConfigBase"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AgentShopifyConfig"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
shopify_app_uninstalled_webhook_api_v1_shopify_webhooks_app_uninstalled_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
shopify_customers_data_request_webhook_api_v1_shopify_webhooks_customers_data_request_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
shopify_customers_redact_webhook_api_v1_shopify_webhooks_customers_redact_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
shopify_shop_redact_webhook_api_v1_shopify_webhooks_shop_redact_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
create_workflow_api_v1_workflow_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["WorkflowCreate"];
};
};
responses: {
/** @description Successful Response */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["WorkflowResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_workflow_by_agent_id_api_v1_workflow_agent__agent_id__get: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["WorkflowResponse"] | null;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_workflow_api_v1_workflow__workflow_id__put: {
parameters: {
query?: never;
header?: never;
path: {
workflow_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["WorkflowUpdate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["WorkflowResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_workflow_api_v1_workflow__workflow_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
workflow_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
204: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_workflow_nodes_api_v1_workflow__workflow_id__nodes_get: {
parameters: {
query?: never;
header?: never;
path: {
workflow_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["WorkflowNodesResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
replace_workflow_nodes_api_v1_workflow__workflow_id__nodes_put: {
parameters: {
query?: never;
header?: never;
path: {
workflow_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["WorkflowNodesUpdateRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["WorkflowNodesResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_workflow_node_api_v1_workflow__workflow_id__nodes__node_id__get: {
parameters: {
query?: never;
header?: never;
path: {
workflow_id: string;
node_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["WorkflowNodeResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_workflow_node_api_v1_workflow__workflow_id__nodes__node_id__put: {
parameters: {
query?: never;
header?: never;
path: {
workflow_id: string;
node_id: string;
};
cookie?: {
access_token?: string | null;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["WorkflowNodeUpdate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["WorkflowNodeResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
serve_signed_local_file_api_v1_files_local__file_path__get: {
parameters: {
query?: {
exp?: number | null;
sig?: string | null;
};
header?: never;
path: {
file_path: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
download_file_api_v1_files_download__file_path__get: {
parameters: {
query?: never;
header?: {
authorization?: string | null;
"x-conversation-token"?: string | null;
};
path: {
file_path: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
root__get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
get_health_check: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
head_health_check: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
}