@graph8/sdk 0.251.0 → 0.260.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/README.md +9 -2
- package/dist/cli.js +216 -0
- package/dist/index.d.mts +104 -7
- package/dist/index.d.ts +104 -7
- package/dist/index.js +44 -3
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +44 -3
- package/dist/index.mjs.map +1 -1
- package/dist/react.d.mts +102 -7
- package/dist/react.d.ts +102 -7
- package/dist/react.js +62 -11
- package/dist/react.js.map +1 -1
- package/dist/react.mjs +53 -12
- package/dist/react.mjs.map +1 -1
- package/dist/types/README.md +7 -0
- package/dist/types/agency.d.ts +20 -0
- package/dist/types/agentSetup.d.ts +57 -0
- package/dist/types/api.d.ts +127 -0
- package/dist/types/appClient.d.ts +99 -0
- package/dist/types/appPlatform.d.ts +269 -0
- package/dist/types/appTokens.d.ts +125 -0
- package/dist/types/apps.d.ts +130 -0
- package/dist/types/audiences.d.ts +88 -0
- package/dist/types/calendar.d.ts +55 -0
- package/dist/types/campaigns.d.ts +61 -0
- package/dist/types/chat.d.ts +35 -0
- package/dist/types/cli.d.ts +14 -0
- package/dist/types/companies.d.ts +123 -0
- package/dist/types/contacts.d.ts +200 -0
- package/dist/types/copilot.d.ts +31 -0
- package/dist/types/core.d.ts +1052 -0
- package/dist/types/deals.d.ts +215 -0
- package/dist/types/enrich.d.ts +51 -0
- package/dist/types/fields.d.ts +84 -0
- package/dist/types/forms.d.ts +16 -0
- package/dist/types/http.d.ts +141 -0
- package/dist/types/inbox.d.ts +123 -0
- package/dist/types/index.d.ts +63 -0
- package/dist/types/intent.d.ts +196 -0
- package/dist/types/lists.d.ts +44 -0
- package/dist/types/mailboxes.d.ts +240 -0
- package/dist/types/marketplace.d.ts +62 -0
- package/dist/types/meetings.d.ts +70 -0
- package/dist/types/newsletter.d.ts +212 -0
- package/dist/types/notes.d.ts +57 -0
- package/dist/types/objects.d.ts +281 -0
- package/dist/types/pipelines.d.ts +135 -0
- package/dist/types/quotes.d.ts +143 -0
- package/dist/types/react.d.ts +978 -0
- package/dist/types/search.d.ts +99 -0
- package/dist/types/sequences.d.ts +255 -0
- package/dist/types/signals.d.ts +28 -0
- package/dist/types/skills.d.ts +176 -0
- package/dist/types/snippet.d.ts +24 -0
- package/dist/types/studio.d.ts +161 -0
- package/dist/types/tasks.d.ts +101 -0
- package/dist/types/types.d.ts +45 -0
- package/dist/types/utils.d.ts +21 -0
- package/dist/types/version.d.ts +10 -0
- package/dist/types/visitors.d.ts +29 -0
- package/dist/types/voice.d.ts +304 -0
- package/dist/types/webhooks.d.ts +71 -0
- package/dist/types/workflows.d.ts +229 -0
- package/docs/agents.md +748 -0
- package/docs/api/README.md +165 -0
- package/docs/api/accounts.d.ts +396 -0
- package/docs/api/accounts.md +644 -0
- package/docs/api/adCampaigns.d.ts +707 -0
- package/docs/api/adCampaigns.md +1091 -0
- package/docs/api/adCreatives.d.ts +996 -0
- package/docs/api/adCreatives.md +1708 -0
- package/docs/api/agency.d.ts +556 -0
- package/docs/api/agency.md +845 -0
- package/docs/api/agent.d.ts +330 -0
- package/docs/api/agent.md +514 -0
- package/docs/api/agents.d.ts +1622 -0
- package/docs/api/agents.md +2860 -0
- package/docs/api/aiInbox.d.ts +1984 -0
- package/docs/api/aiInbox.md +3490 -0
- package/docs/api/analytics.d.ts +1273 -0
- package/docs/api/analytics.md +2095 -0
- package/docs/api/apiKeys.d.ts +252 -0
- package/docs/api/apiKeys.md +318 -0
- package/docs/api/appDeployments.d.ts +236 -0
- package/docs/api/appDeployments.md +471 -0
- package/docs/api/appDomains.d.ts +171 -0
- package/docs/api/appDomains.md +281 -0
- package/docs/api/appLogs.d.ts +120 -0
- package/docs/api/appLogs.md +159 -0
- package/docs/api/appObjects.d.ts +415 -0
- package/docs/api/appObjects.md +568 -0
- package/docs/api/appPages.d.ts +557 -0
- package/docs/api/appPages.md +796 -0
- package/docs/api/appPlatformTokens.d.ts +123 -0
- package/docs/api/appPlatformTokens.md +172 -0
- package/docs/api/appointments.d.ts +2361 -0
- package/docs/api/appointments.md +3917 -0
- package/docs/api/apps.d.ts +822 -0
- package/docs/api/apps.md +1342 -0
- package/docs/api/assertUpsert.d.ts +286 -0
- package/docs/api/assertUpsert.md +370 -0
- package/docs/api/audienceSyncs.d.ts +259 -0
- package/docs/api/audienceSyncs.md +395 -0
- package/docs/api/brandKit.d.ts +686 -0
- package/docs/api/brandKit.md +1133 -0
- package/docs/api/bugReports.d.ts +181 -0
- package/docs/api/bugReports.md +268 -0
- package/docs/api/by-path.md +3260 -0
- package/docs/api/calendarInvites.d.ts +117 -0
- package/docs/api/calendarInvites.md +148 -0
- package/docs/api/campaignWorkflows.d.ts +152 -0
- package/docs/api/campaignWorkflows.md +200 -0
- package/docs/api/campaigns.d.ts +721 -0
- package/docs/api/campaigns.md +1236 -0
- package/docs/api/channels.d.ts +171 -0
- package/docs/api/channels.md +235 -0
- package/docs/api/cliCampaigns.d.ts +205 -0
- package/docs/api/cliCampaigns.md +256 -0
- package/docs/api/cliPipelines.d.ts +324 -0
- package/docs/api/cliPipelines.md +562 -0
- package/docs/api/clickHouse.d.ts +115 -0
- package/docs/api/clickHouse.md +138 -0
- package/docs/api/companies.d.ts +1636 -0
- package/docs/api/companies.md +2211 -0
- package/docs/api/companyIntelligence.d.ts +299 -0
- package/docs/api/companyIntelligence.md +488 -0
- package/docs/api/contacts.d.ts +2173 -0
- package/docs/api/contacts.md +3143 -0
- package/docs/api/content.d.ts +968 -0
- package/docs/api/content.md +1667 -0
- package/docs/api/contentGridSkills.d.ts +177 -0
- package/docs/api/contentGridSkills.md +271 -0
- package/docs/api/copilot.d.ts +1017 -0
- package/docs/api/copilot.md +1765 -0
- package/docs/api/crmSyncs.d.ts +215 -0
- package/docs/api/crmSyncs.md +301 -0
- package/docs/api/customerSuccess.d.ts +491 -0
- package/docs/api/customerSuccess.md +776 -0
- package/docs/api/deals.d.ts +1696 -0
- package/docs/api/deals.md +2432 -0
- package/docs/api/deliverability.d.ts +418 -0
- package/docs/api/deliverability.md +677 -0
- package/docs/api/desk.d.ts +1765 -0
- package/docs/api/desk.md +3007 -0
- package/docs/api/dialer.d.ts +1185 -0
- package/docs/api/dialer.md +2166 -0
- package/docs/api/dialerAnalytics.d.ts +187 -0
- package/docs/api/dialerAnalytics.md +257 -0
- package/docs/api/documents.d.ts +895 -0
- package/docs/api/documents.md +1440 -0
- package/docs/api/duplicates.d.ts +195 -0
- package/docs/api/duplicates.md +315 -0
- package/docs/api/eSign.d.ts +38 -0
- package/docs/api/eSign.md +54 -0
- package/docs/api/eSignature.d.ts +242 -0
- package/docs/api/eSignature.md +341 -0
- package/docs/api/enrichment.d.ts +3207 -0
- package/docs/api/enrichment.md +5225 -0
- package/docs/api/events.d.ts +115 -0
- package/docs/api/events.md +105 -0
- package/docs/api/fields.d.ts +482 -0
- package/docs/api/fields.md +566 -0
- package/docs/api/forms.d.ts +1012 -0
- package/docs/api/forms.md +1542 -0
- package/docs/api/gtmCampaigns.d.ts +662 -0
- package/docs/api/gtmCampaigns.md +1044 -0
- package/docs/api/gtmContext.d.ts +1187 -0
- package/docs/api/gtmContext.md +2112 -0
- package/docs/api/gtmDeliverability.d.ts +60 -0
- package/docs/api/gtmDeliverability.md +63 -0
- package/docs/api/gtmKnowledgeBase.d.ts +76 -0
- package/docs/api/gtmKnowledgeBase.md +91 -0
- package/docs/api/gtmLaunchHelpers.d.ts +123 -0
- package/docs/api/gtmLaunchHelpers.md +148 -0
- package/docs/api/gtmLibrary.d.ts +448 -0
- package/docs/api/gtmLibrary.md +780 -0
- package/docs/api/health.d.ts +39 -0
- package/docs/api/health.md +58 -0
- package/docs/api/imageLibrary.d.ts +341 -0
- package/docs/api/imageLibrary.md +569 -0
- package/docs/api/imports.d.ts +157 -0
- package/docs/api/imports.md +174 -0
- package/docs/api/inbox.d.ts +709 -0
- package/docs/api/inbox.md +1067 -0
- package/docs/api/install.d.ts +213 -0
- package/docs/api/install.md +317 -0
- package/docs/api/installedApps.d.ts +131 -0
- package/docs/api/installedApps.md +241 -0
- package/docs/api/integrationStatus.d.ts +142 -0
- package/docs/api/integrationStatus.md +205 -0
- package/docs/api/integrations.d.ts +2327 -0
- package/docs/api/integrations.md +3791 -0
- package/docs/api/intent.d.ts +482 -0
- package/docs/api/intent.md +858 -0
- package/docs/api/knowledge.d.ts +501 -0
- package/docs/api/knowledge.md +843 -0
- package/docs/api/knowledgeBase.d.ts +84 -0
- package/docs/api/knowledgeBase.md +96 -0
- package/docs/api/landingPages.d.ts +1411 -0
- package/docs/api/landingPages.md +2488 -0
- package/docs/api/leads.d.ts +133 -0
- package/docs/api/leads.md +180 -0
- package/docs/api/library.d.ts +217 -0
- package/docs/api/library.md +338 -0
- package/docs/api/linkedIn.d.ts +227 -0
- package/docs/api/linkedIn.md +289 -0
- package/docs/api/linkedInOutreach.d.ts +727 -0
- package/docs/api/linkedInOutreach.md +990 -0
- package/docs/api/lists.d.ts +1106 -0
- package/docs/api/lists.md +1609 -0
- package/docs/api/logs.d.ts +71 -0
- package/docs/api/logs.md +70 -0
- package/docs/api/mailboxes.d.ts +1050 -0
- package/docs/api/mailboxes.md +1690 -0
- package/docs/api/marketingIntelligence.d.ts +256 -0
- package/docs/api/marketingIntelligence.md +454 -0
- package/docs/api/marketplace.d.ts +3173 -0
- package/docs/api/marketplace.md +5953 -0
- package/docs/api/mcp.d.ts +69 -0
- package/docs/api/mcp.md +69 -0
- package/docs/api/me.d.ts +54 -0
- package/docs/api/me.md +56 -0
- package/docs/api/meetings.d.ts +539 -0
- package/docs/api/meetings.md +747 -0
- package/docs/api/newsletter.d.ts +1613 -0
- package/docs/api/newsletter.md +2746 -0
- package/docs/api/notes.d.ts +517 -0
- package/docs/api/notes.md +888 -0
- package/docs/api/notifications.d.ts +94 -0
- package/docs/api/notifications.md +105 -0
- package/docs/api/objects.d.ts +621 -0
- package/docs/api/objects.md +1098 -0
- package/docs/api/openSearch.d.ts +234 -0
- package/docs/api/openSearch.md +297 -0
- package/docs/api/ops.d.ts +299 -0
- package/docs/api/ops.md +339 -0
- package/docs/api/orgGovernance.d.ts +393 -0
- package/docs/api/orgGovernance.md +623 -0
- package/docs/api/orgVideos.d.ts +184 -0
- package/docs/api/orgVideos.md +252 -0
- package/docs/api/organizationSettings.d.ts +626 -0
- package/docs/api/organizationSettings.md +911 -0
- package/docs/api/phoneNumbers.d.ts +484 -0
- package/docs/api/phoneNumbers.md +777 -0
- package/docs/api/profile.d.ts +329 -0
- package/docs/api/profile.md +540 -0
- package/docs/api/programmaticPages.d.ts +400 -0
- package/docs/api/programmaticPages.md +626 -0
- package/docs/api/providerDomains.d.ts +866 -0
- package/docs/api/providerDomains.md +1446 -0
- package/docs/api/providerUsage.d.ts +129 -0
- package/docs/api/providerUsage.md +186 -0
- package/docs/api/public.d.ts +69 -0
- package/docs/api/public.md +78 -0
- package/docs/api/publicCopilot.d.ts +67 -0
- package/docs/api/publicCopilot.md +80 -0
- package/docs/api/publicSignals.d.ts +66 -0
- package/docs/api/publicSignals.md +71 -0
- package/docs/api/publicVisitors.d.ts +97 -0
- package/docs/api/publicVisitors.md +118 -0
- package/docs/api/quotes.d.ts +1564 -0
- package/docs/api/quotes.md +2553 -0
- package/docs/api/radar.d.ts +808 -0
- package/docs/api/radar.md +1431 -0
- package/docs/api/radarReports.d.ts +208 -0
- package/docs/api/radarReports.md +306 -0
- package/docs/api/recordRoles.d.ts +143 -0
- package/docs/api/recordRoles.md +175 -0
- package/docs/api/repos.d.ts +146 -0
- package/docs/api/repos.md +211 -0
- package/docs/api/research.d.ts +295 -0
- package/docs/api/research.md +534 -0
- package/docs/api/revenue.d.ts +402 -0
- package/docs/api/revenue.md +608 -0
- package/docs/api/revenueAnalytics.d.ts +147 -0
- package/docs/api/revenueAnalytics.md +212 -0
- package/docs/api/revenueLifecycle.d.ts +207 -0
- package/docs/api/revenueLifecycle.md +274 -0
- package/docs/api/revenueRecords.d.ts +372 -0
- package/docs/api/revenueRecords.md +563 -0
- package/docs/api/roles.d.ts +431 -0
- package/docs/api/roles.md +812 -0
- package/docs/api/salesCoach.d.ts +877 -0
- package/docs/api/salesCoach.md +1540 -0
- package/docs/api/sandbox.d.ts +210 -0
- package/docs/api/sandbox.md +380 -0
- package/docs/api/scans.d.ts +104 -0
- package/docs/api/scans.md +136 -0
- package/docs/api/scheduleBuy.d.ts +293 -0
- package/docs/api/scheduleBuy.md +431 -0
- package/docs/api/scraping.d.ts +266 -0
- package/docs/api/scraping.md +383 -0
- package/docs/api/sdrAnalytics.d.ts +138 -0
- package/docs/api/sdrAnalytics.md +246 -0
- package/docs/api/search.d.ts +598 -0
- package/docs/api/search.md +866 -0
- package/docs/api/seo.d.ts +447 -0
- package/docs/api/seo.md +660 -0
- package/docs/api/sequenceLifecycle.d.ts +439 -0
- package/docs/api/sequenceLifecycle.md +513 -0
- package/docs/api/sequences.d.ts +1936 -0
- package/docs/api/sequences.md +3232 -0
- package/docs/api/settings.d.ts +448 -0
- package/docs/api/settings.md +731 -0
- package/docs/api/signals.d.ts +1441 -0
- package/docs/api/signals.md +2526 -0
- package/docs/api/signatures.d.ts +719 -0
- package/docs/api/signatures.md +1247 -0
- package/docs/api/skills.d.ts +230 -0
- package/docs/api/skills.md +466 -0
- package/docs/api/snippet.d.ts +85 -0
- package/docs/api/snippet.md +106 -0
- package/docs/api/socialPublishing.d.ts +824 -0
- package/docs/api/socialPublishing.md +1245 -0
- package/docs/api/studioDocuments.d.ts +244 -0
- package/docs/api/studioDocuments.md +348 -0
- package/docs/api/support.d.ts +90 -0
- package/docs/api/support.md +76 -0
- package/docs/api/suppressions.d.ts +241 -0
- package/docs/api/suppressions.md +343 -0
- package/docs/api/surveys.d.ts +847 -0
- package/docs/api/surveys.md +1223 -0
- package/docs/api/tasks.d.ts +813 -0
- package/docs/api/tasks.md +1344 -0
- package/docs/api/teamMembers.d.ts +668 -0
- package/docs/api/teamMembers.md +1040 -0
- package/docs/api/teams.d.ts +784 -0
- package/docs/api/teams.md +1395 -0
- package/docs/api/usage.d.ts +277 -0
- package/docs/api/usage.md +389 -0
- package/docs/api/visitors.d.ts +690 -0
- package/docs/api/visitors.md +1075 -0
- package/docs/api/voice.d.ts +4661 -0
- package/docs/api/voice.md +7905 -0
- package/docs/api/webAnalytics.d.ts +964 -0
- package/docs/api/webAnalytics.md +1452 -0
- package/docs/api/webChat.d.ts +1704 -0
- package/docs/api/webChat.md +2048 -0
- package/docs/api/webhooks.d.ts +251 -0
- package/docs/api/webhooks.md +386 -0
- package/docs/api/websiteEditor.d.ts +324 -0
- package/docs/api/websiteEditor.md +517 -0
- package/docs/api/work.d.ts +2298 -0
- package/docs/api/work.md +3096 -0
- package/docs/api/workbench.d.ts +2962 -0
- package/docs/api/workbench.md +4884 -0
- package/docs/api/workflows.d.ts +1218 -0
- package/docs/api/workflows.md +2302 -0
- package/docs/sdk-clients.md +4339 -0
- package/package.json +10 -3
|
@@ -0,0 +1,1185 @@
|
|
|
1
|
+
/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Types for `g8.api.dialer` (Dialer): 46 operations.
|
|
5
|
+
*
|
|
6
|
+
* For reading. In code, import from the package instead:
|
|
7
|
+
* import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
|
|
8
|
+
* type In = ApiInput<"backfill_grading_dialer_parallel_calls_grading_backfill_post">;
|
|
9
|
+
*
|
|
10
|
+
* Reference with examples: dialer.md
|
|
11
|
+
*/
|
|
12
|
+
/* eslint-disable */
|
|
13
|
+
|
|
14
|
+
/** `g8.api.dialer.<member>` -> the operationId it calls. */
|
|
15
|
+
export interface DialerMembers {
|
|
16
|
+
backfillGrading: "backfill_grading_dialer_parallel_calls_grading_backfill_post";
|
|
17
|
+
checkCampaignReadiness: "check_campaign_readiness_dialer_parallel_calls_grading_campaign_readiness_get";
|
|
18
|
+
checkRecordingOwnership: "check_recording_ownership_dialer_parallel_calls_recordings_ownership_get";
|
|
19
|
+
clearSdrTargets: "clear_sdr_targets_dialer_parallel_calls_targets_sdr_delete";
|
|
20
|
+
createPausedParallelSession: "create_paused_parallel_session_dialer_parallel_calls_sessions_post";
|
|
21
|
+
createSessionDraft: "create_session_draft_dialer_sessions_draft_post";
|
|
22
|
+
declineTransfer: "decline_transfer_dialer_transfer__call_id__decline_post";
|
|
23
|
+
deleteCustomDisposition: "delete_custom_disposition_dialer_dispositions__disposition_id__delete";
|
|
24
|
+
dialNextBatch: "dial_next_batch_dialer_sessions__session_id__next_batch_post";
|
|
25
|
+
dropParallelVoicemail: "drop_parallel_voicemail_dialer_parallel_calls_calls__livekit_room_name__drop_voicemail_post";
|
|
26
|
+
dropSessionVoicemail: "drop_session_voicemail_dialer_sessions_calls_drop_voicemail_post";
|
|
27
|
+
hangupParallelCall: "hangup_parallel_call_dialer_parallel_calls_calls_hangup_post";
|
|
28
|
+
hangupSessionCall: "hangup_session_call_dialer_sessions_calls_hangup_post";
|
|
29
|
+
listContactIdsByDisposition: "list_contact_ids_by_disposition_dialer_parallel_calls_sessions__session_id__contact_ids_by_disposition_get";
|
|
30
|
+
listTransferDepartments: "list_transfer_departments_dialer_transfer_departments_get";
|
|
31
|
+
manualDial: "manual_dial_dialer_parallel_calls_manual_dial_post";
|
|
32
|
+
markAllMissedCallbacksSeen: "mark_all_missed_callbacks_seen_dialer_parallel_calls_missed_callbacks_seen_all_patch";
|
|
33
|
+
markGradingReviewed: "mark_grading_reviewed_dialer_parallel_calls_calls__livekit_room_name__grading_review_post";
|
|
34
|
+
markMissedCallbacksSeen: "mark_missed_callbacks_seen_dialer_parallel_calls_missed_callbacks_seen_patch";
|
|
35
|
+
mintSessionWsTicket: "mint_session_ws_ticket_dialer_sessions__session_id__ws_ticket_post";
|
|
36
|
+
mintSoftphoneToken: "mint_softphone_token_dialer_sessions_token_get";
|
|
37
|
+
mintTranscriptWsTicket: "mint_transcript_ws_ticket_dialer_sessions_calls__call_id__ws_ticket_post";
|
|
38
|
+
muteCall: "mute_call_dialer_sessions_calls_mute_post";
|
|
39
|
+
prewarmVoicemails: "prewarm_voicemails_dialer_sessions_prewarm_voicemails_post";
|
|
40
|
+
readAllSdrTargets: "read_all_sdr_targets_dialer_parallel_calls_targets_all_sdrs_get";
|
|
41
|
+
readDialerPreferences: "read_dialer_preferences_dialer_settings_preferences__user_email__get";
|
|
42
|
+
readDialerReport: "read_dialer_report_dialer_parallel_calls_analytics_dialer_report_get";
|
|
43
|
+
readOrgTargets: "read_org_targets_dialer_parallel_calls_targets_get";
|
|
44
|
+
readProviderReceipt: "read_provider_receipt_dialer_sessions_assurance_provider_receipt_get";
|
|
45
|
+
readQueueStats: "read_queue_stats_dialer_sessions__session_id__queue_stats_get";
|
|
46
|
+
readSessionGrid: "read_session_grid_dialer_sessions__session_id__grid_post";
|
|
47
|
+
readTransferStatus: "read_transfer_status_dialer_transfer__call_id__get";
|
|
48
|
+
redialContact: "redial_contact_dialer_parallel_calls_redial_contact_post";
|
|
49
|
+
resolveMissedCallbacks: "resolve_missed_callbacks_dialer_parallel_calls_missed_callbacks_resolve_patch";
|
|
50
|
+
setCallDisposition: "set_call_disposition_dialer_parallel_calls_calls__livekit_room_name__disposition_patch";
|
|
51
|
+
setDialerPreferences: "set_dialer_preferences_dialer_settings_preferences_put";
|
|
52
|
+
setOrgTargets: "set_org_targets_dialer_parallel_calls_targets_put";
|
|
53
|
+
setSdrTargets: "set_sdr_targets_dialer_parallel_calls_targets_sdr_put";
|
|
54
|
+
skipContact: "skip_contact_dialer_sessions__session_id__calls_skip_contact_post";
|
|
55
|
+
startParallelSession: "start_parallel_session_dialer_parallel_calls_sessions_start_post";
|
|
56
|
+
unresolveMissedCallbacks: "unresolve_missed_callbacks_dialer_parallel_calls_missed_callbacks_unresolve_patch";
|
|
57
|
+
unskipContact: "unskip_contact_dialer_sessions__session_id__calls_unskip_contact_post";
|
|
58
|
+
updateRedialState: "update_redial_state_dialer_parallel_calls_sessions__session_id__redial_state_patch";
|
|
59
|
+
updateSessionBookingEventType: "update_session_booking_event_type_dialer_sessions__session_id__booking_event_type_patch";
|
|
60
|
+
updateSessionFilter: "update_session_filter_dialer_sessions__session_id__filter_spec_patch";
|
|
61
|
+
updateSessionHiddenFields: "update_session_hidden_fields_dialer_sessions__session_id__hidden_custom_fields_patch";
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
/** Input and output of every `g8.api.dialer` operation, keyed by operationId. */
|
|
65
|
+
export interface DialerOperations {
|
|
66
|
+
/**
|
|
67
|
+
* POST /dialer/parallel-calls/grading/backfill
|
|
68
|
+
* Backfill Grading
|
|
69
|
+
* tier: billable · scope: voice:run
|
|
70
|
+
*/
|
|
71
|
+
backfill_grading_dialer_parallel_calls_grading_backfill_post: {
|
|
72
|
+
input: {
|
|
73
|
+
query?: {
|
|
74
|
+
/** How far back to look. */
|
|
75
|
+
days?: number;
|
|
76
|
+
/** `true` counts and samples; `false` GRADES AND SPENDS. */
|
|
77
|
+
dry_run?: boolean;
|
|
78
|
+
};
|
|
79
|
+
headers?: {
|
|
80
|
+
"X-Target-Org-Id"?: string | null;
|
|
81
|
+
};
|
|
82
|
+
};
|
|
83
|
+
output: ApiResponse_DialerPayload_;
|
|
84
|
+
};
|
|
85
|
+
/**
|
|
86
|
+
* GET /dialer/parallel-calls/grading/campaign-readiness
|
|
87
|
+
* Check Campaign Readiness
|
|
88
|
+
* tier: read · scope: voice:read
|
|
89
|
+
*/
|
|
90
|
+
check_campaign_readiness_dialer_parallel_calls_grading_campaign_readiness_get: {
|
|
91
|
+
input: {
|
|
92
|
+
headers?: {
|
|
93
|
+
"X-Target-Org-Id"?: string | null;
|
|
94
|
+
};
|
|
95
|
+
};
|
|
96
|
+
output: ApiResponse_DialerPayload_;
|
|
97
|
+
};
|
|
98
|
+
/**
|
|
99
|
+
* GET /dialer/parallel-calls/recordings/ownership
|
|
100
|
+
* Check Recording Ownership
|
|
101
|
+
* tier: read · scope: voice:read
|
|
102
|
+
*/
|
|
103
|
+
check_recording_ownership_dialer_parallel_calls_recordings_ownership_get: {
|
|
104
|
+
input: {
|
|
105
|
+
query: {
|
|
106
|
+
/** Stored recording URL. */
|
|
107
|
+
url: string;
|
|
108
|
+
};
|
|
109
|
+
headers?: {
|
|
110
|
+
"X-Target-Org-Id"?: string | null;
|
|
111
|
+
};
|
|
112
|
+
};
|
|
113
|
+
output: ApiResponse_DialerPayload_;
|
|
114
|
+
};
|
|
115
|
+
/**
|
|
116
|
+
* DELETE /dialer/parallel-calls/targets/sdr
|
|
117
|
+
* Clear Sdr Targets
|
|
118
|
+
* tier: destructive · scope: voice:write
|
|
119
|
+
*/
|
|
120
|
+
clear_sdr_targets_dialer_parallel_calls_targets_sdr_delete: {
|
|
121
|
+
input: {
|
|
122
|
+
query: {
|
|
123
|
+
/** The rep whose override is removed. */
|
|
124
|
+
sdr_email: string;
|
|
125
|
+
};
|
|
126
|
+
headers?: {
|
|
127
|
+
"X-Target-Org-Id"?: string | null;
|
|
128
|
+
};
|
|
129
|
+
};
|
|
130
|
+
output: ApiResponse_DialerPayload_;
|
|
131
|
+
};
|
|
132
|
+
/**
|
|
133
|
+
* POST /dialer/parallel-calls/sessions
|
|
134
|
+
* Create Paused Parallel Session
|
|
135
|
+
* tier: write · scope: voice:write
|
|
136
|
+
*/
|
|
137
|
+
create_paused_parallel_session_dialer_parallel_calls_sessions_post: {
|
|
138
|
+
input: {
|
|
139
|
+
headers?: {
|
|
140
|
+
"X-Target-Org-Id"?: string | null;
|
|
141
|
+
};
|
|
142
|
+
body: CreatePausedSessionRequest;
|
|
143
|
+
};
|
|
144
|
+
output: ApiResponse_DialerPayload_;
|
|
145
|
+
};
|
|
146
|
+
/**
|
|
147
|
+
* POST /dialer/sessions/draft
|
|
148
|
+
* Create Session Draft
|
|
149
|
+
* tier: write · scope: voice:write
|
|
150
|
+
*/
|
|
151
|
+
create_session_draft_dialer_sessions_draft_post: {
|
|
152
|
+
input: {
|
|
153
|
+
headers?: {
|
|
154
|
+
"X-Target-Org-Id"?: string | null;
|
|
155
|
+
};
|
|
156
|
+
body: SessionDraftRequest;
|
|
157
|
+
};
|
|
158
|
+
output: ApiResponse_DialerPayload_;
|
|
159
|
+
};
|
|
160
|
+
/**
|
|
161
|
+
* POST /dialer/transfer/{call_id}/decline
|
|
162
|
+
* Decline Transfer
|
|
163
|
+
* tier: write · scope: voice:write
|
|
164
|
+
*/
|
|
165
|
+
decline_transfer_dialer_transfer__call_id__decline_post: {
|
|
166
|
+
input: {
|
|
167
|
+
path: {
|
|
168
|
+
/** Call being transferred. */
|
|
169
|
+
call_id: string;
|
|
170
|
+
};
|
|
171
|
+
headers?: {
|
|
172
|
+
"X-Target-Org-Id"?: string | null;
|
|
173
|
+
};
|
|
174
|
+
};
|
|
175
|
+
output: ApiResponse_DialerPayload_;
|
|
176
|
+
};
|
|
177
|
+
/**
|
|
178
|
+
* DELETE /dialer/dispositions/{disposition_id}
|
|
179
|
+
* Delete Custom Disposition
|
|
180
|
+
* tier: destructive · scope: voice:write
|
|
181
|
+
*/
|
|
182
|
+
delete_custom_disposition_dialer_dispositions__disposition_id__delete: {
|
|
183
|
+
input: {
|
|
184
|
+
path: {
|
|
185
|
+
/** Custom disposition id. */
|
|
186
|
+
disposition_id: number;
|
|
187
|
+
};
|
|
188
|
+
headers?: {
|
|
189
|
+
"X-Target-Org-Id"?: string | null;
|
|
190
|
+
};
|
|
191
|
+
};
|
|
192
|
+
output: ApiResponse_DialerPayload_;
|
|
193
|
+
};
|
|
194
|
+
/**
|
|
195
|
+
* POST /dialer/sessions/{session_id}/next-batch
|
|
196
|
+
* Dial Next Batch
|
|
197
|
+
* tier: external · scope: voice:run
|
|
198
|
+
*/
|
|
199
|
+
dial_next_batch_dialer_sessions__session_id__next_batch_post: {
|
|
200
|
+
input: {
|
|
201
|
+
path: {
|
|
202
|
+
/** Session to dial. */
|
|
203
|
+
session_id: string;
|
|
204
|
+
};
|
|
205
|
+
headers?: {
|
|
206
|
+
"X-Target-Org-Id"?: string | null;
|
|
207
|
+
};
|
|
208
|
+
body?: NextBatchRequest;
|
|
209
|
+
};
|
|
210
|
+
output: ApiResponse_DialerPayload_;
|
|
211
|
+
};
|
|
212
|
+
/**
|
|
213
|
+
* POST /dialer/parallel-calls/calls/{livekit_room_name}/drop-voicemail
|
|
214
|
+
* Drop Parallel Voicemail
|
|
215
|
+
* tier: external · scope: voice:run
|
|
216
|
+
*/
|
|
217
|
+
drop_parallel_voicemail_dialer_parallel_calls_calls__livekit_room_name__drop_voicemail_post: {
|
|
218
|
+
input: {
|
|
219
|
+
path: {
|
|
220
|
+
/** Room name of the live call. */
|
|
221
|
+
livekit_room_name: string;
|
|
222
|
+
};
|
|
223
|
+
headers?: {
|
|
224
|
+
"X-Target-Org-Id"?: string | null;
|
|
225
|
+
};
|
|
226
|
+
};
|
|
227
|
+
output: ApiResponse_DialerPayload_;
|
|
228
|
+
};
|
|
229
|
+
/**
|
|
230
|
+
* POST /dialer/sessions/calls/drop-voicemail
|
|
231
|
+
* Drop Session Voicemail
|
|
232
|
+
* tier: external · scope: voice:run
|
|
233
|
+
*/
|
|
234
|
+
drop_session_voicemail_dialer_sessions_calls_drop_voicemail_post: {
|
|
235
|
+
input: {
|
|
236
|
+
headers?: {
|
|
237
|
+
"X-Target-Org-Id"?: string | null;
|
|
238
|
+
};
|
|
239
|
+
body: VoicemailDropRequest;
|
|
240
|
+
};
|
|
241
|
+
output: ApiResponse_DialerPayload_;
|
|
242
|
+
};
|
|
243
|
+
/**
|
|
244
|
+
* POST /dialer/parallel-calls/calls/hangup
|
|
245
|
+
* Hangup Parallel Call
|
|
246
|
+
* tier: write · scope: voice:write
|
|
247
|
+
*/
|
|
248
|
+
hangup_parallel_call_dialer_parallel_calls_calls_hangup_post: {
|
|
249
|
+
input: {
|
|
250
|
+
headers?: {
|
|
251
|
+
"X-Target-Org-Id"?: string | null;
|
|
252
|
+
};
|
|
253
|
+
body: HangupCallRequest;
|
|
254
|
+
};
|
|
255
|
+
output: ApiResponse_DialerPayload_;
|
|
256
|
+
};
|
|
257
|
+
/**
|
|
258
|
+
* POST /dialer/sessions/calls/hangup
|
|
259
|
+
* Hangup Session Call
|
|
260
|
+
* tier: write · scope: voice:write
|
|
261
|
+
*/
|
|
262
|
+
hangup_session_call_dialer_sessions_calls_hangup_post: {
|
|
263
|
+
input: {
|
|
264
|
+
headers?: {
|
|
265
|
+
"X-Target-Org-Id"?: string | null;
|
|
266
|
+
};
|
|
267
|
+
body: CallControlRequest;
|
|
268
|
+
};
|
|
269
|
+
output: ApiResponse_DialerPayload_;
|
|
270
|
+
};
|
|
271
|
+
/**
|
|
272
|
+
* GET /dialer/parallel-calls/sessions/{session_id}/contact-ids-by-disposition
|
|
273
|
+
* List Contact Ids By Disposition
|
|
274
|
+
* tier: read · scope: voice:read
|
|
275
|
+
*/
|
|
276
|
+
list_contact_ids_by_disposition_dialer_parallel_calls_sessions__session_id__contact_ids_by_disposition_get: {
|
|
277
|
+
input: {
|
|
278
|
+
path: {
|
|
279
|
+
/** Session id. */
|
|
280
|
+
session_id: string;
|
|
281
|
+
};
|
|
282
|
+
query: {
|
|
283
|
+
/** Disposition, or several comma-separated. */
|
|
284
|
+
disposition: string;
|
|
285
|
+
/** `latest` = current outcome; `has_ever` = any attempt. */
|
|
286
|
+
mode?: string;
|
|
287
|
+
};
|
|
288
|
+
headers?: {
|
|
289
|
+
"X-Target-Org-Id"?: string | null;
|
|
290
|
+
};
|
|
291
|
+
};
|
|
292
|
+
output: ApiResponse_DialerListPayload_;
|
|
293
|
+
};
|
|
294
|
+
/**
|
|
295
|
+
* GET /dialer/transfer/departments
|
|
296
|
+
* List Transfer Departments
|
|
297
|
+
* tier: read · scope: voice:read
|
|
298
|
+
*/
|
|
299
|
+
list_transfer_departments_dialer_transfer_departments_get: {
|
|
300
|
+
input: {
|
|
301
|
+
headers?: {
|
|
302
|
+
"X-Target-Org-Id"?: string | null;
|
|
303
|
+
};
|
|
304
|
+
};
|
|
305
|
+
output: ApiResponse_DialerListPayload_;
|
|
306
|
+
};
|
|
307
|
+
/**
|
|
308
|
+
* POST /dialer/parallel-calls/manual-dial
|
|
309
|
+
* Manual Dial
|
|
310
|
+
* tier: external · scope: voice:run
|
|
311
|
+
*/
|
|
312
|
+
manual_dial_dialer_parallel_calls_manual_dial_post: {
|
|
313
|
+
input: {
|
|
314
|
+
headers?: {
|
|
315
|
+
"X-Target-Org-Id"?: string | null;
|
|
316
|
+
};
|
|
317
|
+
body: ManualDialRequest;
|
|
318
|
+
};
|
|
319
|
+
output: ApiResponse_DialerPayload_;
|
|
320
|
+
};
|
|
321
|
+
/**
|
|
322
|
+
* PATCH /dialer/parallel-calls/missed-callbacks/seen-all
|
|
323
|
+
* Mark All Missed Callbacks Seen
|
|
324
|
+
* tier: write · scope: voice:write
|
|
325
|
+
*/
|
|
326
|
+
mark_all_missed_callbacks_seen_dialer_parallel_calls_missed_callbacks_seen_all_patch: {
|
|
327
|
+
input: {
|
|
328
|
+
headers?: {
|
|
329
|
+
"X-Target-Org-Id"?: string | null;
|
|
330
|
+
};
|
|
331
|
+
body: MissedCallbacksSeenAllRequest;
|
|
332
|
+
};
|
|
333
|
+
output: ApiResponse_DialerPayload_;
|
|
334
|
+
};
|
|
335
|
+
/**
|
|
336
|
+
* POST /dialer/parallel-calls/calls/{livekit_room_name}/grading/review
|
|
337
|
+
* Mark Grading Reviewed
|
|
338
|
+
* tier: write · scope: voice:write
|
|
339
|
+
*/
|
|
340
|
+
mark_grading_reviewed_dialer_parallel_calls_calls__livekit_room_name__grading_review_post: {
|
|
341
|
+
input: {
|
|
342
|
+
path: {
|
|
343
|
+
/** Room name of the graded call. */
|
|
344
|
+
livekit_room_name: string;
|
|
345
|
+
};
|
|
346
|
+
query: {
|
|
347
|
+
/** The rep whose grading was reviewed. */
|
|
348
|
+
sdr_email: string;
|
|
349
|
+
};
|
|
350
|
+
headers?: {
|
|
351
|
+
"X-Target-Org-Id"?: string | null;
|
|
352
|
+
};
|
|
353
|
+
};
|
|
354
|
+
output: ApiResponse_DialerPayload_;
|
|
355
|
+
};
|
|
356
|
+
/**
|
|
357
|
+
* PATCH /dialer/parallel-calls/missed-callbacks/seen
|
|
358
|
+
* Mark Missed Callbacks Seen
|
|
359
|
+
* tier: write · scope: voice:write
|
|
360
|
+
*/
|
|
361
|
+
mark_missed_callbacks_seen_dialer_parallel_calls_missed_callbacks_seen_patch: {
|
|
362
|
+
input: {
|
|
363
|
+
headers?: {
|
|
364
|
+
"X-Target-Org-Id"?: string | null;
|
|
365
|
+
};
|
|
366
|
+
body: MissedCallbacksSeenRequest;
|
|
367
|
+
};
|
|
368
|
+
output: ApiResponse_DialerPayload_;
|
|
369
|
+
};
|
|
370
|
+
/**
|
|
371
|
+
* POST /dialer/sessions/{session_id}/ws-ticket
|
|
372
|
+
* Mint Session Ws Ticket
|
|
373
|
+
* tier: write · scope: voice:write
|
|
374
|
+
*/
|
|
375
|
+
mint_session_ws_ticket_dialer_sessions__session_id__ws_ticket_post: {
|
|
376
|
+
input: {
|
|
377
|
+
path: {
|
|
378
|
+
/** Session to subscribe to. */
|
|
379
|
+
session_id: string;
|
|
380
|
+
};
|
|
381
|
+
headers?: {
|
|
382
|
+
"X-Target-Org-Id"?: string | null;
|
|
383
|
+
};
|
|
384
|
+
};
|
|
385
|
+
output: ApiResponse_DialerPayload_;
|
|
386
|
+
};
|
|
387
|
+
/**
|
|
388
|
+
* GET /dialer/sessions/token
|
|
389
|
+
* Mint Softphone Token
|
|
390
|
+
* tier: external · scope: voice:run
|
|
391
|
+
*/
|
|
392
|
+
mint_softphone_token_dialer_sessions_token_get: {
|
|
393
|
+
input: {
|
|
394
|
+
query: {
|
|
395
|
+
/** The rep this softphone credential is for. */
|
|
396
|
+
user_id: string;
|
|
397
|
+
};
|
|
398
|
+
headers?: {
|
|
399
|
+
"X-Target-Org-Id"?: string | null;
|
|
400
|
+
};
|
|
401
|
+
};
|
|
402
|
+
output: ApiResponse_DialerPayload_;
|
|
403
|
+
};
|
|
404
|
+
/**
|
|
405
|
+
* POST /dialer/sessions/calls/{call_id}/ws-ticket
|
|
406
|
+
* Mint Transcript Ws Ticket
|
|
407
|
+
* tier: write · scope: voice:write
|
|
408
|
+
*/
|
|
409
|
+
mint_transcript_ws_ticket_dialer_sessions_calls__call_id__ws_ticket_post: {
|
|
410
|
+
input: {
|
|
411
|
+
path: {
|
|
412
|
+
/** Call to stream the transcript of. */
|
|
413
|
+
call_id: string;
|
|
414
|
+
};
|
|
415
|
+
headers?: {
|
|
416
|
+
"X-Target-Org-Id"?: string | null;
|
|
417
|
+
};
|
|
418
|
+
};
|
|
419
|
+
output: ApiResponse_DialerPayload_;
|
|
420
|
+
};
|
|
421
|
+
/**
|
|
422
|
+
* POST /dialer/sessions/calls/mute
|
|
423
|
+
* Mute Call
|
|
424
|
+
* tier: write · scope: voice:write
|
|
425
|
+
*/
|
|
426
|
+
mute_call_dialer_sessions_calls_mute_post: {
|
|
427
|
+
input: {
|
|
428
|
+
query: {
|
|
429
|
+
/** The live call to mute. */
|
|
430
|
+
call_id: string;
|
|
431
|
+
/** `true` mutes the rep, `false` unmutes. */
|
|
432
|
+
muted?: boolean;
|
|
433
|
+
};
|
|
434
|
+
headers?: {
|
|
435
|
+
"X-Target-Org-Id"?: string | null;
|
|
436
|
+
};
|
|
437
|
+
};
|
|
438
|
+
output: ApiResponse_DialerPayload_;
|
|
439
|
+
};
|
|
440
|
+
/**
|
|
441
|
+
* POST /dialer/sessions/prewarm-voicemails
|
|
442
|
+
* Prewarm Voicemails
|
|
443
|
+
* tier: billable · scope: voice:run
|
|
444
|
+
*/
|
|
445
|
+
prewarm_voicemails_dialer_sessions_prewarm_voicemails_post: {
|
|
446
|
+
input: {
|
|
447
|
+
headers?: {
|
|
448
|
+
"X-Target-Org-Id"?: string | null;
|
|
449
|
+
};
|
|
450
|
+
body: PrewarmVoicemailsRequest;
|
|
451
|
+
};
|
|
452
|
+
output: ApiResponse_DialerPayload_;
|
|
453
|
+
};
|
|
454
|
+
/**
|
|
455
|
+
* GET /dialer/parallel-calls/targets/all-sdrs
|
|
456
|
+
* Read All Sdr Targets
|
|
457
|
+
* tier: read · scope: voice:read
|
|
458
|
+
*/
|
|
459
|
+
read_all_sdr_targets_dialer_parallel_calls_targets_all_sdrs_get: {
|
|
460
|
+
input: {
|
|
461
|
+
headers?: {
|
|
462
|
+
"X-Target-Org-Id"?: string | null;
|
|
463
|
+
};
|
|
464
|
+
};
|
|
465
|
+
output: ApiResponse_DialerListPayload_;
|
|
466
|
+
};
|
|
467
|
+
/**
|
|
468
|
+
* GET /dialer/settings/preferences/{user_email}
|
|
469
|
+
* Read Dialer Preferences
|
|
470
|
+
* tier: read · scope: voice:read
|
|
471
|
+
*/
|
|
472
|
+
read_dialer_preferences_dialer_settings_preferences__user_email__get: {
|
|
473
|
+
input: {
|
|
474
|
+
path: {
|
|
475
|
+
/** The rep whose preferences to read. */
|
|
476
|
+
user_email: string;
|
|
477
|
+
};
|
|
478
|
+
headers?: {
|
|
479
|
+
"X-Target-Org-Id"?: string | null;
|
|
480
|
+
};
|
|
481
|
+
};
|
|
482
|
+
output: ApiResponse_DialerPayload_;
|
|
483
|
+
};
|
|
484
|
+
/**
|
|
485
|
+
* GET /dialer/parallel-calls/analytics/dialer-report
|
|
486
|
+
* Read Dialer Report
|
|
487
|
+
* tier: read · scope: voice:read
|
|
488
|
+
*/
|
|
489
|
+
read_dialer_report_dialer_parallel_calls_analytics_dialer_report_get: {
|
|
490
|
+
input: {
|
|
491
|
+
query?: {
|
|
492
|
+
/** Restrict to one session. */
|
|
493
|
+
session_id?: string | null;
|
|
494
|
+
/** Restrict to one rep. */
|
|
495
|
+
user_email?: string | null;
|
|
496
|
+
/** ISO date, inclusive. */
|
|
497
|
+
date_from?: string | null;
|
|
498
|
+
/** ISO date, inclusive. */
|
|
499
|
+
date_to?: string | null;
|
|
500
|
+
/** `daily` buckets; `total` collapses. */
|
|
501
|
+
aggregation?: "daily" | "total";
|
|
502
|
+
/** IANA zone the day boundaries are cut on. */
|
|
503
|
+
client_tz?: string | null;
|
|
504
|
+
};
|
|
505
|
+
headers?: {
|
|
506
|
+
"X-Target-Org-Id"?: string | null;
|
|
507
|
+
};
|
|
508
|
+
};
|
|
509
|
+
output: ApiResponse_DialerPayload_;
|
|
510
|
+
};
|
|
511
|
+
/**
|
|
512
|
+
* GET /dialer/parallel-calls/targets
|
|
513
|
+
* Read Org Targets
|
|
514
|
+
* tier: read · scope: voice:read
|
|
515
|
+
*/
|
|
516
|
+
read_org_targets_dialer_parallel_calls_targets_get: {
|
|
517
|
+
input: {
|
|
518
|
+
headers?: {
|
|
519
|
+
"X-Target-Org-Id"?: string | null;
|
|
520
|
+
};
|
|
521
|
+
};
|
|
522
|
+
output: ApiResponse_DialerPayload_;
|
|
523
|
+
};
|
|
524
|
+
/**
|
|
525
|
+
* GET /dialer/sessions/assurance/provider-receipt
|
|
526
|
+
* Read Provider Receipt
|
|
527
|
+
* tier: read · scope: voice:read
|
|
528
|
+
*/
|
|
529
|
+
read_provider_receipt_dialer_sessions_assurance_provider_receipt_get: {
|
|
530
|
+
input: {
|
|
531
|
+
headers?: {
|
|
532
|
+
"X-Target-Org-Id"?: string | null;
|
|
533
|
+
};
|
|
534
|
+
};
|
|
535
|
+
output: ApiResponse_DialerPayload_;
|
|
536
|
+
};
|
|
537
|
+
/**
|
|
538
|
+
* GET /dialer/sessions/{session_id}/queue-stats
|
|
539
|
+
* Read Queue Stats
|
|
540
|
+
* tier: read · scope: voice:read
|
|
541
|
+
*/
|
|
542
|
+
read_queue_stats_dialer_sessions__session_id__queue_stats_get: {
|
|
543
|
+
input: {
|
|
544
|
+
path: {
|
|
545
|
+
/** Session id. */
|
|
546
|
+
session_id: string;
|
|
547
|
+
};
|
|
548
|
+
headers?: {
|
|
549
|
+
"X-Target-Org-Id"?: string | null;
|
|
550
|
+
};
|
|
551
|
+
};
|
|
552
|
+
output: ApiResponse_DialerPayload_;
|
|
553
|
+
};
|
|
554
|
+
/**
|
|
555
|
+
* POST /dialer/sessions/{session_id}/grid
|
|
556
|
+
* Read Session Grid
|
|
557
|
+
* tier: read · scope: voice:read
|
|
558
|
+
*/
|
|
559
|
+
read_session_grid_dialer_sessions__session_id__grid_post: {
|
|
560
|
+
input: {
|
|
561
|
+
path: {
|
|
562
|
+
/** Session id. */
|
|
563
|
+
session_id: string;
|
|
564
|
+
};
|
|
565
|
+
headers?: {
|
|
566
|
+
"X-Target-Org-Id"?: string | null;
|
|
567
|
+
};
|
|
568
|
+
body?: GridPageRequest;
|
|
569
|
+
};
|
|
570
|
+
output: ApiResponse_DialerListPayload_;
|
|
571
|
+
};
|
|
572
|
+
/**
|
|
573
|
+
* GET /dialer/transfer/{call_id}
|
|
574
|
+
* Read Transfer Status
|
|
575
|
+
* tier: read · scope: voice:read
|
|
576
|
+
*/
|
|
577
|
+
read_transfer_status_dialer_transfer__call_id__get: {
|
|
578
|
+
input: {
|
|
579
|
+
path: {
|
|
580
|
+
/** Call being transferred. */
|
|
581
|
+
call_id: string;
|
|
582
|
+
};
|
|
583
|
+
headers?: {
|
|
584
|
+
"X-Target-Org-Id"?: string | null;
|
|
585
|
+
};
|
|
586
|
+
};
|
|
587
|
+
output: ApiResponse_DialerPayload_;
|
|
588
|
+
};
|
|
589
|
+
/**
|
|
590
|
+
* POST /dialer/parallel-calls/redial-contact
|
|
591
|
+
* Redial Contact
|
|
592
|
+
* tier: external · scope: voice:run
|
|
593
|
+
*/
|
|
594
|
+
redial_contact_dialer_parallel_calls_redial_contact_post: {
|
|
595
|
+
input: {
|
|
596
|
+
headers?: {
|
|
597
|
+
"X-Target-Org-Id"?: string | null;
|
|
598
|
+
};
|
|
599
|
+
body: RedialContactRequest;
|
|
600
|
+
};
|
|
601
|
+
output: ApiResponse_DialerPayload_;
|
|
602
|
+
};
|
|
603
|
+
/**
|
|
604
|
+
* PATCH /dialer/parallel-calls/missed-callbacks/resolve
|
|
605
|
+
* Resolve Missed Callbacks
|
|
606
|
+
* tier: write · scope: voice:write
|
|
607
|
+
*/
|
|
608
|
+
resolve_missed_callbacks_dialer_parallel_calls_missed_callbacks_resolve_patch: {
|
|
609
|
+
input: {
|
|
610
|
+
headers?: {
|
|
611
|
+
"X-Target-Org-Id"?: string | null;
|
|
612
|
+
};
|
|
613
|
+
body: MissedCallbacksResolveRequest;
|
|
614
|
+
};
|
|
615
|
+
output: ApiResponse_DialerPayload_;
|
|
616
|
+
};
|
|
617
|
+
/**
|
|
618
|
+
* PATCH /dialer/parallel-calls/calls/{livekit_room_name}/disposition
|
|
619
|
+
* Set Call Disposition
|
|
620
|
+
* tier: write · scope: voice:write
|
|
621
|
+
*/
|
|
622
|
+
set_call_disposition_dialer_parallel_calls_calls__livekit_room_name__disposition_patch: {
|
|
623
|
+
input: {
|
|
624
|
+
path: {
|
|
625
|
+
/** Room name of the call. */
|
|
626
|
+
livekit_room_name: string;
|
|
627
|
+
};
|
|
628
|
+
headers?: {
|
|
629
|
+
"X-Target-Org-Id"?: string | null;
|
|
630
|
+
};
|
|
631
|
+
body: CallDispositionRequest;
|
|
632
|
+
};
|
|
633
|
+
output: ApiResponse_DialerPayload_;
|
|
634
|
+
};
|
|
635
|
+
/**
|
|
636
|
+
* PUT /dialer/settings/preferences
|
|
637
|
+
* Set Dialer Preferences
|
|
638
|
+
* tier: write · scope: voice:write
|
|
639
|
+
*/
|
|
640
|
+
set_dialer_preferences_dialer_settings_preferences_put: {
|
|
641
|
+
input: {
|
|
642
|
+
headers?: {
|
|
643
|
+
"X-Target-Org-Id"?: string | null;
|
|
644
|
+
};
|
|
645
|
+
body: DialerPreferencesRequest;
|
|
646
|
+
};
|
|
647
|
+
output: ApiResponse_DialerPayload_;
|
|
648
|
+
};
|
|
649
|
+
/**
|
|
650
|
+
* PUT /dialer/parallel-calls/targets
|
|
651
|
+
* Set Org Targets
|
|
652
|
+
* tier: write · scope: voice:write
|
|
653
|
+
*/
|
|
654
|
+
set_org_targets_dialer_parallel_calls_targets_put: {
|
|
655
|
+
input: {
|
|
656
|
+
headers?: {
|
|
657
|
+
"X-Target-Org-Id"?: string | null;
|
|
658
|
+
};
|
|
659
|
+
body: OrgDialerTargetsRequest;
|
|
660
|
+
};
|
|
661
|
+
output: ApiResponse_DialerPayload_;
|
|
662
|
+
};
|
|
663
|
+
/**
|
|
664
|
+
* PUT /dialer/parallel-calls/targets/sdr
|
|
665
|
+
* Set Sdr Targets
|
|
666
|
+
* tier: write · scope: voice:write
|
|
667
|
+
*/
|
|
668
|
+
set_sdr_targets_dialer_parallel_calls_targets_sdr_put: {
|
|
669
|
+
input: {
|
|
670
|
+
headers?: {
|
|
671
|
+
"X-Target-Org-Id"?: string | null;
|
|
672
|
+
};
|
|
673
|
+
body: SdrDialerTargetsRequest;
|
|
674
|
+
};
|
|
675
|
+
output: ApiResponse_DialerPayload_;
|
|
676
|
+
};
|
|
677
|
+
/**
|
|
678
|
+
* POST /dialer/sessions/{session_id}/calls/skip-contact
|
|
679
|
+
* Skip Contact
|
|
680
|
+
* tier: write · scope: voice:write
|
|
681
|
+
*/
|
|
682
|
+
skip_contact_dialer_sessions__session_id__calls_skip_contact_post: {
|
|
683
|
+
input: {
|
|
684
|
+
path: {
|
|
685
|
+
/** Session id. */
|
|
686
|
+
session_id: string;
|
|
687
|
+
};
|
|
688
|
+
headers?: {
|
|
689
|
+
"X-Target-Org-Id"?: string | null;
|
|
690
|
+
};
|
|
691
|
+
body: SkipContactRequest;
|
|
692
|
+
};
|
|
693
|
+
output: ApiResponse_DialerPayload_;
|
|
694
|
+
};
|
|
695
|
+
/**
|
|
696
|
+
* POST /dialer/parallel-calls/sessions/start
|
|
697
|
+
* Start Parallel Session
|
|
698
|
+
* tier: external · scope: voice:run
|
|
699
|
+
*/
|
|
700
|
+
start_parallel_session_dialer_parallel_calls_sessions_start_post: {
|
|
701
|
+
input: {
|
|
702
|
+
headers?: {
|
|
703
|
+
"X-Target-Org-Id"?: string | null;
|
|
704
|
+
};
|
|
705
|
+
body: StartParallelSessionRequest;
|
|
706
|
+
};
|
|
707
|
+
output: ApiResponse_DialerPayload_;
|
|
708
|
+
};
|
|
709
|
+
/**
|
|
710
|
+
* PATCH /dialer/parallel-calls/missed-callbacks/unresolve
|
|
711
|
+
* Unresolve Missed Callbacks
|
|
712
|
+
* tier: write · scope: voice:write
|
|
713
|
+
*/
|
|
714
|
+
unresolve_missed_callbacks_dialer_parallel_calls_missed_callbacks_unresolve_patch: {
|
|
715
|
+
input: {
|
|
716
|
+
headers?: {
|
|
717
|
+
"X-Target-Org-Id"?: string | null;
|
|
718
|
+
};
|
|
719
|
+
body: MissedCallbacksUnresolveRequest;
|
|
720
|
+
};
|
|
721
|
+
output: ApiResponse_DialerPayload_;
|
|
722
|
+
};
|
|
723
|
+
/**
|
|
724
|
+
* POST /dialer/sessions/{session_id}/calls/unskip-contact
|
|
725
|
+
* Unskip Contact
|
|
726
|
+
* tier: write · scope: voice:write
|
|
727
|
+
*/
|
|
728
|
+
unskip_contact_dialer_sessions__session_id__calls_unskip_contact_post: {
|
|
729
|
+
input: {
|
|
730
|
+
path: {
|
|
731
|
+
/** Session id. */
|
|
732
|
+
session_id: string;
|
|
733
|
+
};
|
|
734
|
+
headers?: {
|
|
735
|
+
"X-Target-Org-Id"?: string | null;
|
|
736
|
+
};
|
|
737
|
+
body: SkipContactRequest;
|
|
738
|
+
};
|
|
739
|
+
output: ApiResponse_DialerPayload_;
|
|
740
|
+
};
|
|
741
|
+
/**
|
|
742
|
+
* PATCH /dialer/parallel-calls/sessions/{session_id}/redial-state
|
|
743
|
+
* Update Redial State
|
|
744
|
+
* tier: write · scope: voice:write
|
|
745
|
+
*/
|
|
746
|
+
update_redial_state_dialer_parallel_calls_sessions__session_id__redial_state_patch: {
|
|
747
|
+
input: {
|
|
748
|
+
path: {
|
|
749
|
+
/** Session id. */
|
|
750
|
+
session_id: string;
|
|
751
|
+
};
|
|
752
|
+
headers?: {
|
|
753
|
+
"X-Target-Org-Id"?: string | null;
|
|
754
|
+
};
|
|
755
|
+
body: UpdateRedialStateRequest;
|
|
756
|
+
};
|
|
757
|
+
output: ApiResponse_DialerPayload_;
|
|
758
|
+
};
|
|
759
|
+
/**
|
|
760
|
+
* PATCH /dialer/sessions/{session_id}/booking-event-type
|
|
761
|
+
* Update Session Booking Event Type
|
|
762
|
+
* tier: write · scope: voice:write
|
|
763
|
+
*/
|
|
764
|
+
update_session_booking_event_type_dialer_sessions__session_id__booking_event_type_patch: {
|
|
765
|
+
input: {
|
|
766
|
+
path: {
|
|
767
|
+
/** Session id. */
|
|
768
|
+
session_id: string;
|
|
769
|
+
};
|
|
770
|
+
headers?: {
|
|
771
|
+
"X-Target-Org-Id"?: string | null;
|
|
772
|
+
};
|
|
773
|
+
body: BookingEventTypePatchRequest;
|
|
774
|
+
};
|
|
775
|
+
output: ApiResponse_DialerPayload_;
|
|
776
|
+
};
|
|
777
|
+
/**
|
|
778
|
+
* PATCH /dialer/sessions/{session_id}/filter-spec
|
|
779
|
+
* Update Session Filter
|
|
780
|
+
* tier: write · scope: voice:write
|
|
781
|
+
*/
|
|
782
|
+
update_session_filter_dialer_sessions__session_id__filter_spec_patch: {
|
|
783
|
+
input: {
|
|
784
|
+
path: {
|
|
785
|
+
/** Session id. */
|
|
786
|
+
session_id: string;
|
|
787
|
+
};
|
|
788
|
+
headers?: {
|
|
789
|
+
"X-Target-Org-Id"?: string | null;
|
|
790
|
+
};
|
|
791
|
+
body: FilterSpecPatchRequest;
|
|
792
|
+
};
|
|
793
|
+
output: ApiResponse_DialerPayload_;
|
|
794
|
+
};
|
|
795
|
+
/**
|
|
796
|
+
* PATCH /dialer/sessions/{session_id}/hidden-custom-fields
|
|
797
|
+
* Update Session Hidden Fields
|
|
798
|
+
* tier: write · scope: voice:write
|
|
799
|
+
*/
|
|
800
|
+
update_session_hidden_fields_dialer_sessions__session_id__hidden_custom_fields_patch: {
|
|
801
|
+
input: {
|
|
802
|
+
path: {
|
|
803
|
+
/** Session id. */
|
|
804
|
+
session_id: string;
|
|
805
|
+
};
|
|
806
|
+
headers?: {
|
|
807
|
+
"X-Target-Org-Id"?: string | null;
|
|
808
|
+
};
|
|
809
|
+
body: HiddenCustomFieldsPatchRequest;
|
|
810
|
+
};
|
|
811
|
+
output: ApiResponse_DialerPayload_;
|
|
812
|
+
};
|
|
813
|
+
}
|
|
814
|
+
|
|
815
|
+
// 36 schemas referenced above (the same as G8Contract.<Name>).
|
|
816
|
+
|
|
817
|
+
export interface ApiResponse_DialerListPayload_ {
|
|
818
|
+
data: DialerListPayload;
|
|
819
|
+
pagination?: PaginationMeta | null;
|
|
820
|
+
}
|
|
821
|
+
|
|
822
|
+
export interface ApiResponse_DialerPayload_ {
|
|
823
|
+
data: DialerPayload;
|
|
824
|
+
pagination?: PaginationMeta | null;
|
|
825
|
+
}
|
|
826
|
+
|
|
827
|
+
/** Mirrors `BookingEventTypePatchRequest`. */
|
|
828
|
+
export interface BookingEventTypePatchRequest {
|
|
829
|
+
selected_event_type_id?: number | null;
|
|
830
|
+
}
|
|
831
|
+
|
|
832
|
+
/** Mirrors `DialerCallControl`. Ends a call already in progress. */
|
|
833
|
+
export interface CallControlRequest {
|
|
834
|
+
call_id: string;
|
|
835
|
+
session_id: string;
|
|
836
|
+
}
|
|
837
|
+
|
|
838
|
+
/**
|
|
839
|
+
* Mirrors `CallDispositionRequest`. Records the outcome of a finished call.
|
|
840
|
+
*
|
|
841
|
+
* `disposition` is left an open string on purpose: the vocabulary is
|
|
842
|
+
* system values PLUS the org's own custom dispositions, so closing it here
|
|
843
|
+
* would refuse a value the customer defined. `GET /voice/dispositions`
|
|
844
|
+
* lists what this org accepts.
|
|
845
|
+
*/
|
|
846
|
+
export interface CallDispositionRequest {
|
|
847
|
+
callback_at?: string | null;
|
|
848
|
+
disposition: string;
|
|
849
|
+
notes?: string | null;
|
|
850
|
+
sentiment?: string | null;
|
|
851
|
+
}
|
|
852
|
+
|
|
853
|
+
/** Mirrors `CreateSessionRequest` minus `org_id`. Dials NOBODY. */
|
|
854
|
+
export interface CreatePausedSessionRequest {
|
|
855
|
+
campaign_builder_campaign_id?: string | null;
|
|
856
|
+
campaign_id?: string | null;
|
|
857
|
+
dialing_mode?: ("power" | "parallel") | null;
|
|
858
|
+
from_phone: string;
|
|
859
|
+
name?: string | null;
|
|
860
|
+
parallel_count?: number | null;
|
|
861
|
+
session_id?: string | null;
|
|
862
|
+
session_metadata?: SessionMetadataIn | null;
|
|
863
|
+
user_email?: string | null;
|
|
864
|
+
user_id: string;
|
|
865
|
+
}
|
|
866
|
+
|
|
867
|
+
/**
|
|
868
|
+
* One person to call. `to_phone` is a REAL phone number of a REAL human.
|
|
869
|
+
*
|
|
870
|
+
* An unparseable number is SKIPPED rather than rejecting the batch, so read
|
|
871
|
+
* the response to learn who was actually dialed.
|
|
872
|
+
*/
|
|
873
|
+
export interface DialContact {
|
|
874
|
+
all_phones?: Array<Record<string, unknown>> | null;
|
|
875
|
+
company?: string | null;
|
|
876
|
+
contact_id: string;
|
|
877
|
+
default_region?: string | null;
|
|
878
|
+
dynamic_columns?: Record<string, unknown> | null;
|
|
879
|
+
email?: string | null;
|
|
880
|
+
first_name?: string | null;
|
|
881
|
+
is_redial?: boolean | null;
|
|
882
|
+
last_name?: string | null;
|
|
883
|
+
original_call_id?: string | null;
|
|
884
|
+
phone_index?: number | null;
|
|
885
|
+
redial_count?: number | null;
|
|
886
|
+
timezone?: string;
|
|
887
|
+
title?: string | null;
|
|
888
|
+
to_phone: string;
|
|
889
|
+
}
|
|
890
|
+
|
|
891
|
+
/** An open envelope for a LIST result, so a bare list keeps its shape. */
|
|
892
|
+
export interface DialerListPayload {
|
|
893
|
+
items?: Array<unknown>;
|
|
894
|
+
[key: string]: unknown;
|
|
895
|
+
}
|
|
896
|
+
|
|
897
|
+
/**
|
|
898
|
+
* An open envelope for one dialer result.
|
|
899
|
+
*
|
|
900
|
+
* Open because voice owns the shape of a session, a call stub and a queue
|
|
901
|
+
* stat, and it grows them without a contract bump here. A dropped field
|
|
902
|
+
* would otherwise turn an added upstream field into a removed public one.
|
|
903
|
+
*/
|
|
904
|
+
export type DialerPayload = Record<string, unknown>;
|
|
905
|
+
|
|
906
|
+
/**
|
|
907
|
+
* Mirrors `UserPreferencesRequest` minus `org_id`.
|
|
908
|
+
*
|
|
909
|
+
* `call_dnc_contacts` decides whether the dialer will call numbers on a
|
|
910
|
+
* do-not-call list. It is a compliance switch, not a convenience one.
|
|
911
|
+
*/
|
|
912
|
+
export interface DialerPreferencesRequest {
|
|
913
|
+
auto_rotate_numbers?: boolean | null;
|
|
914
|
+
call_dnc_contacts?: boolean | null;
|
|
915
|
+
parallel_count?: number | null;
|
|
916
|
+
skip_voicemails?: boolean | null;
|
|
917
|
+
user_email: string;
|
|
918
|
+
}
|
|
919
|
+
|
|
920
|
+
/**
|
|
921
|
+
* One clause of a queue filter. `conditions` nests for AND/OR groups.
|
|
922
|
+
*
|
|
923
|
+
* `conditions` is typed as a list of plain objects rather than as a list of
|
|
924
|
+
* `FilterPredicate`, ON PURPOSE. Voice's own model IS recursive, and this
|
|
925
|
+
* one was too, which made it the only self-referencing schema in the
|
|
926
|
+
* published contract - and the developer-docs renderer recurses on a
|
|
927
|
+
* self-referencing schema with no depth limit until Node runs out of memory
|
|
928
|
+
* (`verify-help-docs` and `User help coverage and rendering` both died with
|
|
929
|
+
* exit 134 on every head that carried it). The wire format is unchanged:
|
|
930
|
+
* each entry has this same shape (`field`, `op`, `value`, `values`,
|
|
931
|
+
* `conditions`) and is forwarded to voice as-is, which validates it against
|
|
932
|
+
* its recursive model. The parity test compares field NAMES, so it still
|
|
933
|
+
* pins this model to voice's.
|
|
934
|
+
*/
|
|
935
|
+
export interface FilterPredicate {
|
|
936
|
+
/** Nested predicates for AND/OR groups. Each entry has the same shape as this object: field, op, value, values and, optionally, its own conditions. */
|
|
937
|
+
conditions?: Array<Record<string, unknown>> | null;
|
|
938
|
+
field: string;
|
|
939
|
+
op: string;
|
|
940
|
+
value?: unknown | null;
|
|
941
|
+
values?: Array<unknown> | null;
|
|
942
|
+
}
|
|
943
|
+
|
|
944
|
+
/**
|
|
945
|
+
* Which contacts in the list are eligible to be dialed.
|
|
946
|
+
*
|
|
947
|
+
* Narrowing this on a RUNNING session changes who gets called next. It is
|
|
948
|
+
* not a display filter.
|
|
949
|
+
*/
|
|
950
|
+
export interface FilterSpec {
|
|
951
|
+
exclude_dispositions?: Array<string>;
|
|
952
|
+
predicates?: Array<FilterPredicate>;
|
|
953
|
+
search?: string | null;
|
|
954
|
+
}
|
|
955
|
+
|
|
956
|
+
/** Mirrors `FilterSpecPatchRequest`. Changes WHO GETS CALLED NEXT. */
|
|
957
|
+
export interface FilterSpecPatchRequest {
|
|
958
|
+
filter_spec?: FilterSpec | null;
|
|
959
|
+
order_spec?: OrderSpec | null;
|
|
960
|
+
}
|
|
961
|
+
|
|
962
|
+
/** Jump one specific contact to the front of the next batch. */
|
|
963
|
+
export interface ForceNextContact {
|
|
964
|
+
contact_id: string;
|
|
965
|
+
phone_field: string;
|
|
966
|
+
}
|
|
967
|
+
|
|
968
|
+
/** Mirrors `GridPageRequest`. A read - it paginates the queue grid. */
|
|
969
|
+
export interface GridPageRequest {
|
|
970
|
+
filter_spec?: FilterSpec | null;
|
|
971
|
+
include_contact_data?: boolean;
|
|
972
|
+
limit?: number;
|
|
973
|
+
offset?: number;
|
|
974
|
+
order_spec?: OrderSpec | null;
|
|
975
|
+
sort_model?: Array<Record<string, string>> | null;
|
|
976
|
+
valid_phones_only?: boolean;
|
|
977
|
+
}
|
|
978
|
+
|
|
979
|
+
/** Mirrors `HangupCallRequest`. Ends a call already in progress. */
|
|
980
|
+
export interface HangupCallRequest {
|
|
981
|
+
call_id: string;
|
|
982
|
+
session_id: string;
|
|
983
|
+
}
|
|
984
|
+
|
|
985
|
+
/** Mirrors `HiddenCustomFieldsPatchRequest`. Display only. */
|
|
986
|
+
export interface HiddenCustomFieldsPatchRequest {
|
|
987
|
+
hidden_custom_fields: Array<string>;
|
|
988
|
+
}
|
|
989
|
+
|
|
990
|
+
/** Mirrors `ManualDialRequest` minus `org_id`. CALLS `to_phone`. */
|
|
991
|
+
export interface ManualDialRequest {
|
|
992
|
+
company?: string | null;
|
|
993
|
+
contact_id?: string | null;
|
|
994
|
+
email?: string | null;
|
|
995
|
+
first_name?: string | null;
|
|
996
|
+
from_phone: string;
|
|
997
|
+
last_name?: string | null;
|
|
998
|
+
session_id: string;
|
|
999
|
+
timezone?: string | null;
|
|
1000
|
+
to_phone: string;
|
|
1001
|
+
user_email?: string | null;
|
|
1002
|
+
user_id: string;
|
|
1003
|
+
}
|
|
1004
|
+
|
|
1005
|
+
/** Mirrors `MissedCallResolveRequest` minus `org_id`. */
|
|
1006
|
+
export interface MissedCallbacksResolveRequest {
|
|
1007
|
+
ids: Array<number>;
|
|
1008
|
+
resolution?: "manual" | "ignored";
|
|
1009
|
+
user_email: string;
|
|
1010
|
+
}
|
|
1011
|
+
|
|
1012
|
+
/** Mirrors `MissedCallSeenAllRequest`. */
|
|
1013
|
+
export interface MissedCallbacksSeenAllRequest {
|
|
1014
|
+
user_email: string;
|
|
1015
|
+
}
|
|
1016
|
+
|
|
1017
|
+
/** Mirrors `MissedCallSeenRequest` minus `org_id`. */
|
|
1018
|
+
export interface MissedCallbacksSeenRequest {
|
|
1019
|
+
ids: Array<number>;
|
|
1020
|
+
user_email: string;
|
|
1021
|
+
}
|
|
1022
|
+
|
|
1023
|
+
/** Mirrors `MissedCallUnresolveRequest` minus `org_id`. */
|
|
1024
|
+
export interface MissedCallbacksUnresolveRequest {
|
|
1025
|
+
ids: Array<number>;
|
|
1026
|
+
user_email: string;
|
|
1027
|
+
}
|
|
1028
|
+
|
|
1029
|
+
/**
|
|
1030
|
+
* Mirrors `NextBatchRequest`. THIS REQUEST DIALS PEOPLE.
|
|
1031
|
+
*
|
|
1032
|
+
* `parallel_count` is how many humans are called AT ONCE.
|
|
1033
|
+
*/
|
|
1034
|
+
export interface NextBatchRequest {
|
|
1035
|
+
agent_id?: string | null;
|
|
1036
|
+
campaign_builder_campaign_id?: string | null;
|
|
1037
|
+
campaign_id?: string | null;
|
|
1038
|
+
dialing_mode?: ("power" | "parallel") | null;
|
|
1039
|
+
entity_type?: string | null;
|
|
1040
|
+
filter_spec?: FilterSpec | null;
|
|
1041
|
+
force_next_contact?: ForceNextContact | null;
|
|
1042
|
+
from_phone?: string | null;
|
|
1043
|
+
from_phone_scope?: string | null;
|
|
1044
|
+
order_spec?: OrderSpec | null;
|
|
1045
|
+
parallel_count?: number | null;
|
|
1046
|
+
previous_batch_id?: string | null;
|
|
1047
|
+
resume_intent?: boolean;
|
|
1048
|
+
user_email?: string | null;
|
|
1049
|
+
}
|
|
1050
|
+
|
|
1051
|
+
/** The order the queue is worked in, and which phone field is tried first. */
|
|
1052
|
+
export interface OrderSpec {
|
|
1053
|
+
mode?: "natural_skip_dialed" | "dialed_first";
|
|
1054
|
+
phone_priority?: Array<string>;
|
|
1055
|
+
sort_model?: Array<Record<string, string>>;
|
|
1056
|
+
}
|
|
1057
|
+
|
|
1058
|
+
/**
|
|
1059
|
+
* Org-wide daily goals. Voice takes these as QUERY params; they are a
|
|
1060
|
+
* body here because they are a record being written, not a filter.
|
|
1061
|
+
*/
|
|
1062
|
+
export interface OrgDialerTargetsRequest {
|
|
1063
|
+
daily_dials_target?: number;
|
|
1064
|
+
daily_meetings_target?: number;
|
|
1065
|
+
updated_by?: string | null;
|
|
1066
|
+
}
|
|
1067
|
+
|
|
1068
|
+
export interface PaginationMeta {
|
|
1069
|
+
/** Whether there are more pages */
|
|
1070
|
+
has_next: boolean;
|
|
1071
|
+
/** Items per page */
|
|
1072
|
+
limit: number;
|
|
1073
|
+
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
1074
|
+
next_cursor?: string | null;
|
|
1075
|
+
/** Current page number (1-indexed) */
|
|
1076
|
+
page: number;
|
|
1077
|
+
/** Total number of items */
|
|
1078
|
+
total: number;
|
|
1079
|
+
}
|
|
1080
|
+
|
|
1081
|
+
/**
|
|
1082
|
+
* Mirrors `DialerPrewarmRequest` minus `org_id`.
|
|
1083
|
+
*
|
|
1084
|
+
* SYNTHESISES voicemail audio ahead of time. Contacts nobody, but it is real
|
|
1085
|
+
* text-to-speech work per contact, which is why it is not a plain write.
|
|
1086
|
+
* Voice caps the batch at 20 and that cap is mirrored here so an oversized
|
|
1087
|
+
* batch is a 422 from this API rather than a round-trip.
|
|
1088
|
+
*/
|
|
1089
|
+
export interface PrewarmVoicemailsRequest {
|
|
1090
|
+
agent_id?: string | null;
|
|
1091
|
+
contacts: Array<DialContact>;
|
|
1092
|
+
}
|
|
1093
|
+
|
|
1094
|
+
/** Mirrors `RedialContactRequest` minus `org_id`. CALLS THE CONTACT AGAIN. */
|
|
1095
|
+
export interface RedialContactRequest {
|
|
1096
|
+
campaign_builder_campaign_id?: string | null;
|
|
1097
|
+
campaign_id?: string | null;
|
|
1098
|
+
contact_id: string;
|
|
1099
|
+
from_phone: string;
|
|
1100
|
+
session_id: string;
|
|
1101
|
+
user_email?: string | null;
|
|
1102
|
+
user_id: string;
|
|
1103
|
+
}
|
|
1104
|
+
|
|
1105
|
+
/** Where a bulk redial sweep got to, so it can resume. */
|
|
1106
|
+
export interface RedialState {
|
|
1107
|
+
filters_snapshot: Record<string, unknown>;
|
|
1108
|
+
last_contact_id?: number;
|
|
1109
|
+
processed_count?: number;
|
|
1110
|
+
started_at: string;
|
|
1111
|
+
}
|
|
1112
|
+
|
|
1113
|
+
/** One rep's daily goals, overriding the org default. */
|
|
1114
|
+
export interface SdrDialerTargetsRequest {
|
|
1115
|
+
daily_dials_target: number;
|
|
1116
|
+
daily_meetings_target: number;
|
|
1117
|
+
sdr_email: string;
|
|
1118
|
+
updated_by?: string | null;
|
|
1119
|
+
}
|
|
1120
|
+
|
|
1121
|
+
/**
|
|
1122
|
+
* Mirrors `CreateBeQueueSessionRequest` minus `org_id`.
|
|
1123
|
+
*
|
|
1124
|
+
* Either `list_id` or `sequence_id` is required - voice 400s with neither,
|
|
1125
|
+
* and that is left to voice rather than duplicated here so the two cannot
|
|
1126
|
+
* disagree about which combinations are legal.
|
|
1127
|
+
*/
|
|
1128
|
+
export interface SessionDraftRequest {
|
|
1129
|
+
agent_id?: string | null;
|
|
1130
|
+
campaign_builder_campaign_id?: string | null;
|
|
1131
|
+
campaign_id?: string | null;
|
|
1132
|
+
dialing_mode?: ("power" | "parallel") | null;
|
|
1133
|
+
entity_type?: string | null;
|
|
1134
|
+
filter_spec?: FilterSpec | null;
|
|
1135
|
+
from_phone?: string | null;
|
|
1136
|
+
list_id?: string | null;
|
|
1137
|
+
list_title?: string | null;
|
|
1138
|
+
name?: string | null;
|
|
1139
|
+
order_spec?: OrderSpec | null;
|
|
1140
|
+
parallel_count?: number;
|
|
1141
|
+
selected_event_type_id?: number | null;
|
|
1142
|
+
sequence_id?: string | null;
|
|
1143
|
+
sequence_step_order?: number | null;
|
|
1144
|
+
user_email?: string | null;
|
|
1145
|
+
user_id: string;
|
|
1146
|
+
user_timezone?: string | null;
|
|
1147
|
+
}
|
|
1148
|
+
|
|
1149
|
+
/** Free-form session context. Open: voice grows this per release. */
|
|
1150
|
+
export type SessionMetadataIn = Record<string, unknown>;
|
|
1151
|
+
|
|
1152
|
+
/** Mirrors `DialerSkipContact`. Queue bookkeeping - dials nobody. */
|
|
1153
|
+
export interface SkipContactRequest {
|
|
1154
|
+
contact_id: string;
|
|
1155
|
+
}
|
|
1156
|
+
|
|
1157
|
+
/** Mirrors `ParallelDialRequest` minus `org_id`. THIS DIALS EVERY CONTACT. */
|
|
1158
|
+
export interface StartParallelSessionRequest {
|
|
1159
|
+
campaign_builder_campaign_id?: string | null;
|
|
1160
|
+
campaign_id?: string | null;
|
|
1161
|
+
contacts: Array<DialContact>;
|
|
1162
|
+
from_phone: string;
|
|
1163
|
+
name?: string | null;
|
|
1164
|
+
session_id?: string | null;
|
|
1165
|
+
session_metadata?: SessionMetadataIn | null;
|
|
1166
|
+
user_email?: string | null;
|
|
1167
|
+
user_id: string;
|
|
1168
|
+
}
|
|
1169
|
+
|
|
1170
|
+
/** Mirrors `UpdateRedialStateRequest`. Bookkeeping - dials nobody. */
|
|
1171
|
+
export interface UpdateRedialStateRequest {
|
|
1172
|
+
redial_state?: RedialState | null;
|
|
1173
|
+
reset?: boolean;
|
|
1174
|
+
}
|
|
1175
|
+
|
|
1176
|
+
/**
|
|
1177
|
+
* Mirrors `DialerVoicemailDrop`.
|
|
1178
|
+
*
|
|
1179
|
+
* LEAVES A REAL VOICEMAIL on a real person's phone in the rep's cloned
|
|
1180
|
+
* voice, then hangs up.
|
|
1181
|
+
*/
|
|
1182
|
+
export interface VoicemailDropRequest {
|
|
1183
|
+
call_id: string;
|
|
1184
|
+
session_id: string;
|
|
1185
|
+
}
|