@opencx/mcp 1.13.1 → 1.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/schema.d.ts CHANGED
@@ -303,6 +303,26 @@ export interface paths {
303
303
  patch: operations["updateChatSession"];
304
304
  trace?: never;
305
305
  };
306
+ "/chat/sessions/{session_id}/handoff": {
307
+ parameters: {
308
+ query?: never;
309
+ header?: never;
310
+ path?: never;
311
+ cookie?: never;
312
+ };
313
+ get?: never;
314
+ put?: never;
315
+ /**
316
+ * Hand the session off to a human agent
317
+ * @description Hands the session off to a human agent, re-running the handoff pipeline even if the session is already handed off. Closed sessions are refused with 400.
318
+ */
319
+ post: operations["handoffChatSession"];
320
+ delete?: never;
321
+ options?: never;
322
+ head?: never;
323
+ patch?: never;
324
+ trace?: never;
325
+ };
306
326
  "/chat/sessions/{session_id}/assignee": {
307
327
  parameters: {
308
328
  query?: never;
@@ -1368,6 +1388,26 @@ export interface paths {
1368
1388
  patch?: never;
1369
1389
  trace?: never;
1370
1390
  };
1391
+ "/macros/variables": {
1392
+ parameters: {
1393
+ query?: never;
1394
+ header?: never;
1395
+ path?: never;
1396
+ cookie?: never;
1397
+ };
1398
+ /**
1399
+ * List macro variables
1400
+ * @description List the variables available for use in macro content: built-in `enums` (system variables like {{contact.full_name}}) and the organization's `custom` variables. Reference them in macro content with {{variable}} syntax. Custom variables are authored and managed in the OpenCX dashboard — this endpoint is read-only.
1401
+ */
1402
+ get: operations["listMacroVariables"];
1403
+ put?: never;
1404
+ post?: never;
1405
+ delete?: never;
1406
+ options?: never;
1407
+ head?: never;
1408
+ patch?: never;
1409
+ trace?: never;
1410
+ };
1371
1411
  "/macros/{id}": {
1372
1412
  parameters: {
1373
1413
  query?: never;
@@ -4492,6 +4532,26 @@ export interface components {
4492
4532
  event: "message:new";
4493
4533
  session_id: string;
4494
4534
  };
4535
+ WebsiteCrawlAuthDto: {
4536
+ /** @constant */
4537
+ type: "basic";
4538
+ username: string;
4539
+ password: string;
4540
+ } | {
4541
+ /** @constant */
4542
+ type: "bearer";
4543
+ token: string;
4544
+ } | {
4545
+ /** @constant */
4546
+ type: "cookie";
4547
+ value: string;
4548
+ } | {
4549
+ /** @constant */
4550
+ type: "headers";
4551
+ headers: {
4552
+ [key: string]: string;
4553
+ };
4554
+ };
4495
4555
  CreateWebsiteDatasourceDto: {
4496
4556
  /** Format: uri */
4497
4557
  url: string;
@@ -4508,6 +4568,7 @@ export interface components {
4508
4568
  auto_start_crawl: boolean;
4509
4569
  /** @default [] */
4510
4570
  restricted_to_channels: components["schemas"]["SessionChannel"][];
4571
+ auth?: components["schemas"]["WebsiteCrawlAuthDto"] | null;
4511
4572
  };
4512
4573
  UpdateWebsiteDatasourceDto: {
4513
4574
  display_name?: string;
@@ -4518,6 +4579,7 @@ export interface components {
4518
4579
  /** @enum {string} */
4519
4580
  status?: "active" | "paused";
4520
4581
  restricted_to_channels?: components["schemas"]["SessionChannel"][];
4582
+ auth?: components["schemas"]["WebsiteCrawlAuthDto"] | null;
4521
4583
  };
4522
4584
  BulkPageActionDto: {
4523
4585
  page_ids: string[];
@@ -5971,7 +6033,7 @@ export interface components {
5971
6033
  }) | null;
5972
6034
  knowledgebase_called?: boolean | null;
5973
6035
  /** @enum {string} */
5974
- type: "agent_assigned_by_integration" | "agent_assigned_by_system" | "agent_assigned_by_user" | "agent_changed" | "agent_comment" | "agent_initiated_session" | "agent_joined" | "agent_message" | "agent_reopened_session" | "agent_took_session_from_ai" | "agent_unassigned_by_integration" | "agent_unassigned_by_system" | "agent_unassigned_by_user" | "ai_assumed_the_session_resolved" | "ai_decided_to_not_reply" | "ai_decided_to_resolve_the_issue" | "ai_reopened_session" | "ai_response_cancelled" | "ai_resumed_by_system" | "call_history" | "call_transferred" | "closed_resolved_by_agent" | "closed_resolved_by_api" | "closed_resolved_by_contact" | "closed_resolved_by_integration" | "closed_resolved_by_system" | "closed_unresolved_by_agent" | "closed_unresolved_by_api" | "closed_unresolved_by_system" | "contact_data_updated" | "csat_requested" | "csat_submitted" | "email_draft_message" | "handoff" | "handoff_to_salesforce_miaw" | "handoff_to_zendesk" | "integration_reopened_session" | "message" | "prohibited_topic_detected" | "sequence_message" | "skills_added_by_system" | "sla_applied_by_agent" | "sla_applied_by_system" | "sla_first_reply_breached" | "sla_first_reply_completed_after_breach" | "sla_first_reply_fulfilled" | "sla_first_reply_metric_started" | "sla_freezed_office_hours_ended" | "sla_freezed_snoozed" | "sla_next_reply_breached" | "sla_next_reply_completed_after_breach" | "sla_next_reply_fulfilled" | "sla_next_reply_metric_started" | "sla_removed_by_agent" | "sla_removed_by_system" | "sla_resolution_breached" | "sla_resolution_completed_after_breach" | "sla_resolution_fulfilled" | "sla_resolution_metric_started" | "sla_resolution_paused_resolved" | "sla_resolution_paused_waiting_on_customer" | "sla_resolution_resumed_customer_replied" | "sla_resolution_resumed_reopened" | "sla_resumed_office_hours_started" | "sla_resumed_snooze_cancelled" | "sla_resumed_snooze_expired" | "state_checkpoint" | "sub_status_removed_by_agent" | "sub_status_removed_by_api" | "sub_status_removed_by_integration" | "sub_status_removed_by_system" | "sub_status_set_by_agent" | "sub_status_set_by_api" | "sub_status_set_by_integration" | "sub_status_set_by_system" | "system_reopened_session" | "tag_added_by_agent" | "tag_added_by_api" | "tag_added_by_integration" | "tag_added_by_system" | "tag_removed_by_agent" | "tag_removed_by_api" | "tag_removed_by_integration" | "tag_removed_by_system" | "team_assigned_by_system" | "team_assigned_by_user" | "team_unassigned_by_system" | "team_unassigned_by_user" | "user_confirmed_the_session_resolved" | "workflow_message" | "workflow_note" | "workflow_triggered";
6036
+ type: "agent_assigned_by_integration" | "agent_assigned_by_system" | "agent_assigned_by_user" | "agent_changed" | "agent_comment" | "agent_initiated_session" | "agent_joined" | "agent_message" | "agent_reopened_session" | "agent_took_session_from_ai" | "agent_unassigned_by_integration" | "agent_unassigned_by_system" | "agent_unassigned_by_user" | "ai_assumed_the_session_resolved" | "ai_decided_to_not_reply" | "ai_decided_to_resolve_the_issue" | "ai_reopened_session" | "ai_response_cancelled" | "ai_resumed_by_system" | "call_history" | "call_transferred" | "closed_resolved_by_agent" | "closed_resolved_by_api" | "closed_resolved_by_contact" | "closed_resolved_by_integration" | "closed_resolved_by_system" | "closed_unresolved_by_agent" | "closed_unresolved_by_api" | "closed_unresolved_by_system" | "contact_data_updated" | "csat_requested" | "csat_submitted" | "email_draft_message" | "handoff" | "handoff_to_salesforce_miaw" | "handoff_to_zendesk" | "integration_reopened_session" | "message" | "prohibited_topic_detected" | "sequence_message" | "skills_added_by_system" | "sla_applied_by_agent" | "sla_applied_by_system" | "sla_first_reply_breached" | "sla_first_reply_completed_after_breach" | "sla_first_reply_fulfilled" | "sla_first_reply_metric_started" | "sla_freezed_office_hours_ended" | "sla_freezed_snoozed" | "sla_next_reply_breached" | "sla_next_reply_completed_after_breach" | "sla_next_reply_fulfilled" | "sla_next_reply_metric_started" | "sla_removed_by_agent" | "sla_removed_by_system" | "sla_resolution_breached" | "sla_resolution_completed_after_breach" | "sla_resolution_fulfilled" | "sla_resolution_metric_started" | "sla_resolution_paused_resolved" | "sla_resolution_paused_waiting_on_customer" | "sla_resolution_resumed_customer_replied" | "sla_resolution_resumed_reopened" | "sla_resumed_office_hours_started" | "sla_resumed_snooze_cancelled" | "sla_resumed_snooze_expired" | "state_checkpoint" | "sub_status_removed_by_agent" | "sub_status_removed_by_api" | "sub_status_removed_by_integration" | "sub_status_removed_by_system" | "sub_status_set_by_agent" | "sub_status_set_by_api" | "sub_status_set_by_integration" | "sub_status_set_by_system" | "system_reopened_session" | "tag_added_by_agent" | "tag_added_by_api" | "tag_added_by_integration" | "tag_added_by_system" | "tag_removed_by_agent" | "tag_removed_by_api" | "tag_removed_by_integration" | "tag_removed_by_system" | "team_assigned_by_integration" | "team_assigned_by_system" | "team_assigned_by_user" | "team_unassigned_by_integration" | "team_unassigned_by_system" | "team_unassigned_by_user" | "user_confirmed_the_session_resolved" | "workflow_message" | "workflow_note" | "workflow_triggered";
5975
6037
  extra_params?: {
5976
6038
  [key: string]: unknown;
5977
6039
  } | null;
@@ -6127,6 +6189,7 @@ export interface components {
6127
6189
  support_office_hours_id: string | null;
6128
6190
  /** @enum {string} */
6129
6191
  support_assignment_strategy: "least-busy" | "round-robin" | "unassigned";
6192
+ zendesk_group_id: string | null;
6130
6193
  created_at: string | null;
6131
6194
  updated_at: string | null;
6132
6195
  deleted_at: string | null;
@@ -6518,6 +6581,22 @@ export interface components {
6518
6581
  /** Format: date-time */
6519
6582
  updated_at: string;
6520
6583
  };
6584
+ SavedReplyVariableDto: {
6585
+ id: string;
6586
+ org_id: string;
6587
+ name: string;
6588
+ content: string;
6589
+ /** Format: date-time */
6590
+ created_at: string;
6591
+ /** Format: date-time */
6592
+ updated_at: string;
6593
+ };
6594
+ /** @enum {string} */
6595
+ SavedReplyVariableEnum: "agent.full_name" | "agent.email" | "contact.full_name" | "contact.email" | "contact.phone" | "session.number" | "session.status" | "session.language" | "org.name";
6596
+ SavedReplyVariablesResponseDto: {
6597
+ enums: components["schemas"]["SavedReplyVariableEnum"][];
6598
+ custom: components["schemas"]["SavedReplyVariableDto"][];
6599
+ };
6521
6600
  AgentAvailability: {
6522
6601
  id: string;
6523
6602
  user_id: number;
@@ -7036,6 +7115,9 @@ export interface components {
7036
7115
  no_change: boolean;
7037
7116
  session: components["schemas"]["GetChatSessionOutput"];
7038
7117
  };
7118
+ HandoffSessionOutput: {
7119
+ session: components["schemas"]["GetChatSessionOutput"];
7120
+ };
7039
7121
  SessionTeamTransferOutput: {
7040
7122
  no_change: boolean;
7041
7123
  session: components["schemas"]["GetChatSessionOutput"];
@@ -7439,6 +7521,10 @@ export interface components {
7439
7521
  /** @constant */
7440
7522
  type: "team_assigned_by_system";
7441
7523
  assigned_team_id?: string;
7524
+ } | {
7525
+ /** @constant */
7526
+ type: "team_assigned_by_integration";
7527
+ assigned_team_id?: string;
7442
7528
  } | {
7443
7529
  /** @constant */
7444
7530
  type: "team_assigned_by_user";
@@ -7448,6 +7534,10 @@ export interface components {
7448
7534
  /** @constant */
7449
7535
  type: "team_unassigned_by_system";
7450
7536
  unassigned_team_id?: string;
7537
+ } | {
7538
+ /** @constant */
7539
+ type: "team_unassigned_by_integration";
7540
+ unassigned_team_id?: string;
7451
7541
  } | {
7452
7542
  /** @constant */
7453
7543
  type: "team_unassigned_by_user";
@@ -7518,6 +7608,10 @@ export interface components {
7518
7608
  created_at: string;
7519
7609
  /** Format: date-time */
7520
7610
  updated_at: string;
7611
+ /** @description Whether optional Firecrawl site auth is configured. Secrets are never returned. */
7612
+ auth_configured: boolean;
7613
+ /** @description Configured auth type, or null when auth is not set. */
7614
+ auth_type: ("basic" | "bearer" | "cookie" | "headers") | null;
7521
7615
  };
7522
7616
  CrawlDatasourceListItem: {
7523
7617
  /** Format: uuid */
@@ -7538,6 +7632,10 @@ export interface components {
7538
7632
  created_at: string;
7539
7633
  /** Format: date-time */
7540
7634
  updated_at: string;
7635
+ /** @description Whether optional Firecrawl site auth is configured. Secrets are never returned. */
7636
+ auth_configured: boolean;
7637
+ /** @description Configured auth type, or null when auth is not set. */
7638
+ auth_type: ("basic" | "bearer" | "cookie" | "headers") | null;
7541
7639
  page_count: number;
7542
7640
  };
7543
7641
  CrawlDatasourceDetail: {
@@ -7559,6 +7657,10 @@ export interface components {
7559
7657
  created_at: string;
7560
7658
  /** Format: date-time */
7561
7659
  updated_at: string;
7660
+ /** @description Whether optional Firecrawl site auth is configured. Secrets are never returned. */
7661
+ auth_configured: boolean;
7662
+ /** @description Configured auth type, or null when auth is not set. */
7663
+ auth_type: ("basic" | "bearer" | "cookie" | "headers") | null;
7562
7664
  page_stats: {
7563
7665
  total: number;
7564
7666
  synced: number;
@@ -9227,6 +9329,38 @@ export interface operations {
9227
9329
  };
9228
9330
  };
9229
9331
  };
9332
+ handoffChatSession: {
9333
+ parameters: {
9334
+ query?: never;
9335
+ header?: never;
9336
+ path: {
9337
+ /** @description The unique identifier of the chat session */
9338
+ session_id: string;
9339
+ };
9340
+ cookie?: never;
9341
+ };
9342
+ requestBody?: never;
9343
+ responses: {
9344
+ /** @description Default Response */
9345
+ 200: {
9346
+ headers: {
9347
+ [name: string]: unknown;
9348
+ };
9349
+ content: {
9350
+ "application/json": components["schemas"]["HandoffSessionOutput"];
9351
+ };
9352
+ };
9353
+ /** @description Internal Server Error */
9354
+ 500: {
9355
+ headers: {
9356
+ [name: string]: unknown;
9357
+ };
9358
+ content: {
9359
+ "application/json": components["schemas"]["ErrorDto"];
9360
+ };
9361
+ };
9362
+ };
9363
+ };
9230
9364
  assignChatSession: {
9231
9365
  parameters: {
9232
9366
  query?: never;
@@ -11416,6 +11550,35 @@ export interface operations {
11416
11550
  };
11417
11551
  };
11418
11552
  };
11553
+ listMacroVariables: {
11554
+ parameters: {
11555
+ query?: never;
11556
+ header?: never;
11557
+ path?: never;
11558
+ cookie?: never;
11559
+ };
11560
+ requestBody?: never;
11561
+ responses: {
11562
+ /** @description Default Response */
11563
+ 200: {
11564
+ headers: {
11565
+ [name: string]: unknown;
11566
+ };
11567
+ content: {
11568
+ "application/json": components["schemas"]["SavedReplyVariablesResponseDto"];
11569
+ };
11570
+ };
11571
+ /** @description Internal Server Error */
11572
+ 500: {
11573
+ headers: {
11574
+ [name: string]: unknown;
11575
+ };
11576
+ content: {
11577
+ "application/json": components["schemas"]["ErrorDto"];
11578
+ };
11579
+ };
11580
+ };
11581
+ };
11419
11582
  getMacro: {
11420
11583
  parameters: {
11421
11584
  query?: never;