@graph8/sdk 0.251.0 → 0.262.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 +105 -7
- package/dist/index.d.ts +105 -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 +103 -7
- package/dist/react.d.ts +103 -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 +1697 -0
- package/docs/api/deals.md +2436 -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,847 @@
|
|
|
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.surveys` (Surveys): 21 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<"create_survey_feedback_surveys_post">;
|
|
9
|
+
*
|
|
10
|
+
* Reference with examples: surveys.md
|
|
11
|
+
*/
|
|
12
|
+
/* eslint-disable */
|
|
13
|
+
|
|
14
|
+
/** `g8.api.surveys.<member>` -> the operationId it calls. */
|
|
15
|
+
export interface SurveysMembers {
|
|
16
|
+
createSurvey: "create_survey_feedback_surveys_post";
|
|
17
|
+
createSurveyTrigger: "create_survey_trigger_feedback_surveys__survey_id__triggers_post";
|
|
18
|
+
deleteSurvey: "delete_survey_feedback_surveys__survey_id__delete";
|
|
19
|
+
deleteSurveyTrigger: "delete_survey_trigger_feedback_surveys__survey_id__triggers__trigger_id__delete";
|
|
20
|
+
getCompanySurveyNps: "get_company_survey_nps_feedback_companies__company_id__nps_get";
|
|
21
|
+
getContactSurveyHistory: "get_contact_survey_history_feedback_contacts__contact_id__history_get";
|
|
22
|
+
getSurvey: "get_survey_feedback_surveys__survey_id__get";
|
|
23
|
+
getSurveyAppUserResponses: "get_survey_app_user_responses_feedback_surveys__survey_id__app_user_responses_get";
|
|
24
|
+
getSurveyOrgSummary: "get_survey_org_summary_feedback_org_summary_get";
|
|
25
|
+
getSurveyResponses: "get_survey_responses_feedback_surveys__survey_id__responses_get";
|
|
26
|
+
getSurveySend: "get_survey_send_feedback_sends__send_id__get";
|
|
27
|
+
getSurveySends: "get_survey_sends_feedback_surveys__survey_id__sends_get";
|
|
28
|
+
getSurveySummary: "get_survey_summary_feedback_surveys__survey_id__summary_get";
|
|
29
|
+
getSurveyTrends: "get_survey_trends_feedback_surveys__survey_id__trends_get";
|
|
30
|
+
listSurveySendingDomains: "list_survey_sending_domains_feedback_sending_domains_get";
|
|
31
|
+
listSurveyTriggers: "list_survey_triggers_feedback_surveys__survey_id__triggers_get";
|
|
32
|
+
listSurveys: "list_surveys_feedback_surveys_get";
|
|
33
|
+
sendSurvey: "send_survey_feedback_surveys__survey_id__send_post";
|
|
34
|
+
surveyDomainStatus: "survey_domain_status_feedback_sending_domains_status_get";
|
|
35
|
+
updateSurvey: "update_survey_feedback_surveys__survey_id__patch";
|
|
36
|
+
verifySurveyDomain: "verify_survey_domain_feedback_sending_domains_verify_post";
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
/** Input and output of every `g8.api.surveys` operation, keyed by operationId. */
|
|
40
|
+
export interface SurveysOperations {
|
|
41
|
+
/**
|
|
42
|
+
* POST /feedback/surveys
|
|
43
|
+
* Create Survey
|
|
44
|
+
* tier: write · scope: surveys:write
|
|
45
|
+
*/
|
|
46
|
+
create_survey_feedback_surveys_post: {
|
|
47
|
+
input: {
|
|
48
|
+
headers?: {
|
|
49
|
+
"X-Target-Org-Id"?: string | null;
|
|
50
|
+
};
|
|
51
|
+
body: CreateSurveyRequest;
|
|
52
|
+
};
|
|
53
|
+
output: ApiResponse_SurveyResponseDTO_;
|
|
54
|
+
};
|
|
55
|
+
/**
|
|
56
|
+
* POST /feedback/surveys/{survey_id}/triggers
|
|
57
|
+
* Create Survey Trigger
|
|
58
|
+
* tier: write · scope: surveys:write
|
|
59
|
+
*/
|
|
60
|
+
create_survey_trigger_feedback_surveys__survey_id__triggers_post: {
|
|
61
|
+
input: {
|
|
62
|
+
path: {
|
|
63
|
+
/** Survey id (UUID) — from GET /feedback/surveys */
|
|
64
|
+
survey_id: string;
|
|
65
|
+
};
|
|
66
|
+
headers?: {
|
|
67
|
+
"X-Target-Org-Id"?: string | null;
|
|
68
|
+
};
|
|
69
|
+
body: CreateSurveyTriggerRequest;
|
|
70
|
+
};
|
|
71
|
+
output: ApiResponse_SurveyTriggerDTO_;
|
|
72
|
+
};
|
|
73
|
+
/**
|
|
74
|
+
* DELETE /feedback/surveys/{survey_id}
|
|
75
|
+
* Delete Survey
|
|
76
|
+
* tier: destructive · scope: surveys:delete
|
|
77
|
+
*/
|
|
78
|
+
delete_survey_feedback_surveys__survey_id__delete: {
|
|
79
|
+
input: {
|
|
80
|
+
path: {
|
|
81
|
+
/** Survey id (UUID) — from GET /feedback/surveys */
|
|
82
|
+
survey_id: string;
|
|
83
|
+
};
|
|
84
|
+
headers?: {
|
|
85
|
+
"X-Target-Org-Id"?: string | null;
|
|
86
|
+
};
|
|
87
|
+
};
|
|
88
|
+
output: ApiResponse_SurveyDeleteResponse_;
|
|
89
|
+
};
|
|
90
|
+
/**
|
|
91
|
+
* DELETE /feedback/surveys/{survey_id}/triggers/{trigger_id}
|
|
92
|
+
* Delete Survey Trigger
|
|
93
|
+
* tier: destructive · scope: surveys:delete
|
|
94
|
+
*/
|
|
95
|
+
delete_survey_trigger_feedback_surveys__survey_id__triggers__trigger_id__delete: {
|
|
96
|
+
input: {
|
|
97
|
+
path: {
|
|
98
|
+
/** Survey id (UUID) — from GET /feedback/surveys */
|
|
99
|
+
survey_id: string;
|
|
100
|
+
/** Trigger id — from GET /feedback/surveys/{survey_id}/triggers */
|
|
101
|
+
trigger_id: string;
|
|
102
|
+
};
|
|
103
|
+
headers?: {
|
|
104
|
+
"X-Target-Org-Id"?: string | null;
|
|
105
|
+
};
|
|
106
|
+
};
|
|
107
|
+
output: ApiResponse_SurveyTriggerDeleteResponse_;
|
|
108
|
+
};
|
|
109
|
+
/**
|
|
110
|
+
* GET /feedback/companies/{company_id}/nps
|
|
111
|
+
* Get Company Survey Nps
|
|
112
|
+
* tier: read · scope: surveys:read
|
|
113
|
+
*/
|
|
114
|
+
get_company_survey_nps_feedback_companies__company_id__nps_get: {
|
|
115
|
+
input: {
|
|
116
|
+
path: {
|
|
117
|
+
/** Company id (mashup_companies.id) */
|
|
118
|
+
company_id: number;
|
|
119
|
+
};
|
|
120
|
+
query?: {
|
|
121
|
+
/** Trend bucket: day, week or month. */
|
|
122
|
+
bucket?: string;
|
|
123
|
+
/** Restrict to one survey. Omit to combine every NPS survey. */
|
|
124
|
+
survey_id?: string | null;
|
|
125
|
+
};
|
|
126
|
+
headers?: {
|
|
127
|
+
"X-Target-Org-Id"?: string | null;
|
|
128
|
+
};
|
|
129
|
+
};
|
|
130
|
+
output: ApiResponse_CompanyNpsDTO_;
|
|
131
|
+
};
|
|
132
|
+
/**
|
|
133
|
+
* GET /feedback/contacts/{contact_id}/history
|
|
134
|
+
* Get Contact Survey History
|
|
135
|
+
* tier: read · scope: surveys:read
|
|
136
|
+
*/
|
|
137
|
+
get_contact_survey_history_feedback_contacts__contact_id__history_get: {
|
|
138
|
+
input: {
|
|
139
|
+
path: {
|
|
140
|
+
/** Contact id (mashup_contacts.id — the primary key) */
|
|
141
|
+
contact_id: number;
|
|
142
|
+
};
|
|
143
|
+
headers?: {
|
|
144
|
+
"X-Target-Org-Id"?: string | null;
|
|
145
|
+
};
|
|
146
|
+
};
|
|
147
|
+
output: ApiResponse_ContactHistoryDTO_;
|
|
148
|
+
};
|
|
149
|
+
/**
|
|
150
|
+
* GET /feedback/surveys/{survey_id}
|
|
151
|
+
* Get Survey
|
|
152
|
+
* tier: read · scope: surveys:read
|
|
153
|
+
*/
|
|
154
|
+
get_survey_feedback_surveys__survey_id__get: {
|
|
155
|
+
input: {
|
|
156
|
+
path: {
|
|
157
|
+
/** Survey id (UUID) — from GET /feedback/surveys */
|
|
158
|
+
survey_id: string;
|
|
159
|
+
};
|
|
160
|
+
headers?: {
|
|
161
|
+
"X-Target-Org-Id"?: string | null;
|
|
162
|
+
};
|
|
163
|
+
};
|
|
164
|
+
output: ApiResponse_SurveyResponseDTO_;
|
|
165
|
+
};
|
|
166
|
+
/**
|
|
167
|
+
* GET /feedback/surveys/{survey_id}/app-user-responses
|
|
168
|
+
* Get Survey App User Responses
|
|
169
|
+
* tier: read · scope: surveys:read
|
|
170
|
+
*/
|
|
171
|
+
get_survey_app_user_responses_feedback_surveys__survey_id__app_user_responses_get: {
|
|
172
|
+
input: {
|
|
173
|
+
path: {
|
|
174
|
+
/** Survey id (UUID) — from GET /feedback/surveys */
|
|
175
|
+
survey_id: string;
|
|
176
|
+
};
|
|
177
|
+
headers?: {
|
|
178
|
+
"X-Target-Org-Id"?: string | null;
|
|
179
|
+
};
|
|
180
|
+
};
|
|
181
|
+
output: ApiResponse_AppUserResponsesDTO_;
|
|
182
|
+
};
|
|
183
|
+
/**
|
|
184
|
+
* GET /feedback/org-summary
|
|
185
|
+
* Get Survey Org Summary
|
|
186
|
+
* tier: read · scope: surveys:read
|
|
187
|
+
*/
|
|
188
|
+
get_survey_org_summary_feedback_org_summary_get: {
|
|
189
|
+
input: {
|
|
190
|
+
query?: {
|
|
191
|
+
/** Restrict to one audience list id. Omit for all contacts. */
|
|
192
|
+
segment?: string | null;
|
|
193
|
+
/** Trend bucket: day, week or month. */
|
|
194
|
+
bucket?: string;
|
|
195
|
+
};
|
|
196
|
+
headers?: {
|
|
197
|
+
"X-Target-Org-Id"?: string | null;
|
|
198
|
+
};
|
|
199
|
+
};
|
|
200
|
+
output: ApiResponse_OrgSummaryDTO_;
|
|
201
|
+
};
|
|
202
|
+
/**
|
|
203
|
+
* GET /feedback/surveys/{survey_id}/responses
|
|
204
|
+
* Get Survey Responses
|
|
205
|
+
* tier: read · scope: surveys:read
|
|
206
|
+
*/
|
|
207
|
+
get_survey_responses_feedback_surveys__survey_id__responses_get: {
|
|
208
|
+
input: {
|
|
209
|
+
path: {
|
|
210
|
+
/** Survey id (UUID) — from GET /feedback/surveys */
|
|
211
|
+
survey_id: string;
|
|
212
|
+
};
|
|
213
|
+
headers?: {
|
|
214
|
+
"X-Target-Org-Id"?: string | null;
|
|
215
|
+
};
|
|
216
|
+
};
|
|
217
|
+
output: ApiResponse_SurveyResponsesDTO_;
|
|
218
|
+
};
|
|
219
|
+
/**
|
|
220
|
+
* GET /feedback/sends/{send_id}
|
|
221
|
+
* Get Survey Send
|
|
222
|
+
* tier: read · scope: surveys:read
|
|
223
|
+
*/
|
|
224
|
+
get_survey_send_feedback_sends__send_id__get: {
|
|
225
|
+
input: {
|
|
226
|
+
path: {
|
|
227
|
+
/** Send id returned by POST /feedback/surveys/{survey_id}/send */
|
|
228
|
+
send_id: number;
|
|
229
|
+
};
|
|
230
|
+
headers?: {
|
|
231
|
+
"X-Target-Org-Id"?: string | null;
|
|
232
|
+
};
|
|
233
|
+
};
|
|
234
|
+
output: ApiResponse_SurveySendDTO_;
|
|
235
|
+
};
|
|
236
|
+
/**
|
|
237
|
+
* GET /feedback/surveys/{survey_id}/sends
|
|
238
|
+
* Get Survey Sends
|
|
239
|
+
* tier: read · scope: surveys:read
|
|
240
|
+
*/
|
|
241
|
+
get_survey_sends_feedback_surveys__survey_id__sends_get: {
|
|
242
|
+
input: {
|
|
243
|
+
path: {
|
|
244
|
+
/** Survey id (UUID) — from GET /feedback/surveys */
|
|
245
|
+
survey_id: string;
|
|
246
|
+
};
|
|
247
|
+
headers?: {
|
|
248
|
+
"X-Target-Org-Id"?: string | null;
|
|
249
|
+
};
|
|
250
|
+
};
|
|
251
|
+
output: ApiResponse_SurveySendsDTO_;
|
|
252
|
+
};
|
|
253
|
+
/**
|
|
254
|
+
* GET /feedback/surveys/{survey_id}/summary
|
|
255
|
+
* Get Survey Summary
|
|
256
|
+
* tier: read · scope: surveys:read
|
|
257
|
+
*/
|
|
258
|
+
get_survey_summary_feedback_surveys__survey_id__summary_get: {
|
|
259
|
+
input: {
|
|
260
|
+
path: {
|
|
261
|
+
/** Survey id (UUID) — from GET /feedback/surveys */
|
|
262
|
+
survey_id: string;
|
|
263
|
+
};
|
|
264
|
+
query?: {
|
|
265
|
+
/** Trend bucket: day, week or month. */
|
|
266
|
+
bucket?: string;
|
|
267
|
+
};
|
|
268
|
+
headers?: {
|
|
269
|
+
"X-Target-Org-Id"?: string | null;
|
|
270
|
+
};
|
|
271
|
+
};
|
|
272
|
+
output: ApiResponse_SummaryDTO_;
|
|
273
|
+
};
|
|
274
|
+
/**
|
|
275
|
+
* GET /feedback/surveys/{survey_id}/trends
|
|
276
|
+
* Get Survey Trends
|
|
277
|
+
* tier: read · scope: surveys:read
|
|
278
|
+
*/
|
|
279
|
+
get_survey_trends_feedback_surveys__survey_id__trends_get: {
|
|
280
|
+
input: {
|
|
281
|
+
path: {
|
|
282
|
+
/** Survey id (UUID) — from GET /feedback/surveys */
|
|
283
|
+
survey_id: string;
|
|
284
|
+
};
|
|
285
|
+
query?: {
|
|
286
|
+
/** Trend bucket: day, week or month. */
|
|
287
|
+
bucket?: string;
|
|
288
|
+
};
|
|
289
|
+
headers?: {
|
|
290
|
+
"X-Target-Org-Id"?: string | null;
|
|
291
|
+
};
|
|
292
|
+
};
|
|
293
|
+
output: ApiResponse_TrendsDTO_;
|
|
294
|
+
};
|
|
295
|
+
/**
|
|
296
|
+
* GET /feedback/sending-domains
|
|
297
|
+
* List Survey Sending Domains
|
|
298
|
+
* tier: read · scope: surveys:read
|
|
299
|
+
*/
|
|
300
|
+
list_survey_sending_domains_feedback_sending_domains_get: {
|
|
301
|
+
input: {
|
|
302
|
+
query?: {
|
|
303
|
+
/** Include domains that are pending or not set up, with their status. */
|
|
304
|
+
include_unverified?: boolean;
|
|
305
|
+
};
|
|
306
|
+
headers?: {
|
|
307
|
+
"X-Target-Org-Id"?: string | null;
|
|
308
|
+
};
|
|
309
|
+
};
|
|
310
|
+
output: ApiResponse_list_SurveySendingDomainDTO__;
|
|
311
|
+
};
|
|
312
|
+
/**
|
|
313
|
+
* GET /feedback/surveys/{survey_id}/triggers
|
|
314
|
+
* List Survey Triggers
|
|
315
|
+
* tier: read · scope: surveys:read
|
|
316
|
+
*/
|
|
317
|
+
list_survey_triggers_feedback_surveys__survey_id__triggers_get: {
|
|
318
|
+
input: {
|
|
319
|
+
path: {
|
|
320
|
+
/** Survey id (UUID) — from GET /feedback/surveys */
|
|
321
|
+
survey_id: string;
|
|
322
|
+
};
|
|
323
|
+
headers?: {
|
|
324
|
+
"X-Target-Org-Id"?: string | null;
|
|
325
|
+
};
|
|
326
|
+
};
|
|
327
|
+
output: ApiResponse_list_SurveyTriggerDTO__;
|
|
328
|
+
};
|
|
329
|
+
/**
|
|
330
|
+
* GET /feedback/surveys
|
|
331
|
+
* List Surveys
|
|
332
|
+
* tier: read · scope: surveys:read
|
|
333
|
+
*/
|
|
334
|
+
list_surveys_feedback_surveys_get: {
|
|
335
|
+
input: {
|
|
336
|
+
headers?: {
|
|
337
|
+
"X-Target-Org-Id"?: string | null;
|
|
338
|
+
};
|
|
339
|
+
};
|
|
340
|
+
output: ApiResponse_list_SurveyResponseDTO__;
|
|
341
|
+
};
|
|
342
|
+
/**
|
|
343
|
+
* POST /feedback/surveys/{survey_id}/send
|
|
344
|
+
* Send Survey
|
|
345
|
+
* tier: external · scope: surveys:run
|
|
346
|
+
*/
|
|
347
|
+
send_survey_feedback_surveys__survey_id__send_post: {
|
|
348
|
+
input: {
|
|
349
|
+
path: {
|
|
350
|
+
/** Survey id (UUID) — from GET /feedback/surveys */
|
|
351
|
+
survey_id: string;
|
|
352
|
+
};
|
|
353
|
+
headers?: {
|
|
354
|
+
"X-Target-Org-Id"?: string | null;
|
|
355
|
+
};
|
|
356
|
+
body: SendSurveyRequest;
|
|
357
|
+
};
|
|
358
|
+
output: ApiResponse_SurveySendAccepted_;
|
|
359
|
+
};
|
|
360
|
+
/**
|
|
361
|
+
* GET /feedback/sending-domains/status
|
|
362
|
+
* Survey Domain Status
|
|
363
|
+
* tier: read · scope: surveys:read
|
|
364
|
+
*/
|
|
365
|
+
survey_domain_status_feedback_sending_domains_status_get: {
|
|
366
|
+
input: {
|
|
367
|
+
query: {
|
|
368
|
+
/** The domain to check. */
|
|
369
|
+
domain: string;
|
|
370
|
+
};
|
|
371
|
+
headers?: {
|
|
372
|
+
"X-Target-Org-Id"?: string | null;
|
|
373
|
+
};
|
|
374
|
+
};
|
|
375
|
+
output: ApiResponse_SurveyDomainPayload_;
|
|
376
|
+
};
|
|
377
|
+
/**
|
|
378
|
+
* PATCH /feedback/surveys/{survey_id}
|
|
379
|
+
* Update Survey
|
|
380
|
+
* tier: write · scope: surveys:write
|
|
381
|
+
*/
|
|
382
|
+
update_survey_feedback_surveys__survey_id__patch: {
|
|
383
|
+
input: {
|
|
384
|
+
path: {
|
|
385
|
+
/** Survey id (UUID) — from GET /feedback/surveys */
|
|
386
|
+
survey_id: string;
|
|
387
|
+
};
|
|
388
|
+
headers?: {
|
|
389
|
+
"X-Target-Org-Id"?: string | null;
|
|
390
|
+
};
|
|
391
|
+
body: UpdateSurveyRequest;
|
|
392
|
+
};
|
|
393
|
+
output: ApiResponse_SurveyResponseDTO_;
|
|
394
|
+
};
|
|
395
|
+
/**
|
|
396
|
+
* POST /feedback/sending-domains/verify
|
|
397
|
+
* Verify Survey Domain
|
|
398
|
+
* tier: external · scope: surveys:run
|
|
399
|
+
*/
|
|
400
|
+
verify_survey_domain_feedback_sending_domains_verify_post: {
|
|
401
|
+
input: {
|
|
402
|
+
headers?: {
|
|
403
|
+
"X-Target-Org-Id"?: string | null;
|
|
404
|
+
};
|
|
405
|
+
body: VerifySurveyDomainRequest;
|
|
406
|
+
};
|
|
407
|
+
output: ApiResponse_SurveyDomainPayload_;
|
|
408
|
+
};
|
|
409
|
+
}
|
|
410
|
+
|
|
411
|
+
// 53 schemas referenced above (the same as G8Contract.<Name>).
|
|
412
|
+
|
|
413
|
+
export interface ApiResponse_AppUserResponsesDTO_ {
|
|
414
|
+
data: AppUserResponsesDTO;
|
|
415
|
+
pagination?: PaginationMeta | null;
|
|
416
|
+
}
|
|
417
|
+
|
|
418
|
+
export interface ApiResponse_CompanyNpsDTO_ {
|
|
419
|
+
data: CompanyNpsDTO;
|
|
420
|
+
pagination?: PaginationMeta | null;
|
|
421
|
+
}
|
|
422
|
+
|
|
423
|
+
export interface ApiResponse_ContactHistoryDTO_ {
|
|
424
|
+
data: ContactHistoryDTO;
|
|
425
|
+
pagination?: PaginationMeta | null;
|
|
426
|
+
}
|
|
427
|
+
|
|
428
|
+
export interface ApiResponse_OrgSummaryDTO_ {
|
|
429
|
+
data: OrgSummaryDTO;
|
|
430
|
+
pagination?: PaginationMeta | null;
|
|
431
|
+
}
|
|
432
|
+
|
|
433
|
+
export interface ApiResponse_SummaryDTO_ {
|
|
434
|
+
data: SummaryDTO;
|
|
435
|
+
pagination?: PaginationMeta | null;
|
|
436
|
+
}
|
|
437
|
+
|
|
438
|
+
export interface ApiResponse_SurveyDeleteResponse_ {
|
|
439
|
+
data: SurveyDeleteResponse;
|
|
440
|
+
pagination?: PaginationMeta | null;
|
|
441
|
+
}
|
|
442
|
+
|
|
443
|
+
export interface ApiResponse_SurveyDomainPayload_ {
|
|
444
|
+
data: SurveyDomainPayload;
|
|
445
|
+
pagination?: PaginationMeta | null;
|
|
446
|
+
}
|
|
447
|
+
|
|
448
|
+
export interface ApiResponse_SurveyResponseDTO_ {
|
|
449
|
+
data: SurveyResponseDTO;
|
|
450
|
+
pagination?: PaginationMeta | null;
|
|
451
|
+
}
|
|
452
|
+
|
|
453
|
+
export interface ApiResponse_SurveyResponsesDTO_ {
|
|
454
|
+
data: SurveyResponsesDTO;
|
|
455
|
+
pagination?: PaginationMeta | null;
|
|
456
|
+
}
|
|
457
|
+
|
|
458
|
+
export interface ApiResponse_SurveySendAccepted_ {
|
|
459
|
+
data: SurveySendAccepted;
|
|
460
|
+
pagination?: PaginationMeta | null;
|
|
461
|
+
}
|
|
462
|
+
|
|
463
|
+
export interface ApiResponse_SurveySendDTO_ {
|
|
464
|
+
data: SurveySendDTO;
|
|
465
|
+
pagination?: PaginationMeta | null;
|
|
466
|
+
}
|
|
467
|
+
|
|
468
|
+
export interface ApiResponse_SurveySendsDTO_ {
|
|
469
|
+
data: SurveySendsDTO;
|
|
470
|
+
pagination?: PaginationMeta | null;
|
|
471
|
+
}
|
|
472
|
+
|
|
473
|
+
export interface ApiResponse_SurveyTriggerDTO_ {
|
|
474
|
+
data: SurveyTriggerDTO;
|
|
475
|
+
pagination?: PaginationMeta | null;
|
|
476
|
+
}
|
|
477
|
+
|
|
478
|
+
export interface ApiResponse_SurveyTriggerDeleteResponse_ {
|
|
479
|
+
data: SurveyTriggerDeleteResponse;
|
|
480
|
+
pagination?: PaginationMeta | null;
|
|
481
|
+
}
|
|
482
|
+
|
|
483
|
+
export interface ApiResponse_TrendsDTO_ {
|
|
484
|
+
data: TrendsDTO;
|
|
485
|
+
pagination?: PaginationMeta | null;
|
|
486
|
+
}
|
|
487
|
+
|
|
488
|
+
export interface ApiResponse_list_SurveyResponseDTO__ {
|
|
489
|
+
data: Array<SurveyResponseDTO>;
|
|
490
|
+
pagination?: PaginationMeta | null;
|
|
491
|
+
}
|
|
492
|
+
|
|
493
|
+
export interface ApiResponse_list_SurveySendingDomainDTO__ {
|
|
494
|
+
data: Array<SurveySendingDomainDTO>;
|
|
495
|
+
pagination?: PaginationMeta | null;
|
|
496
|
+
}
|
|
497
|
+
|
|
498
|
+
export interface ApiResponse_list_SurveyTriggerDTO__ {
|
|
499
|
+
data: Array<SurveyTriggerDTO>;
|
|
500
|
+
pagination?: PaginationMeta | null;
|
|
501
|
+
}
|
|
502
|
+
|
|
503
|
+
export interface AppUserResponseRowDTO {
|
|
504
|
+
app_user_id: string;
|
|
505
|
+
channel: string;
|
|
506
|
+
comment?: string | null;
|
|
507
|
+
responded_at?: string | null;
|
|
508
|
+
score: number;
|
|
509
|
+
}
|
|
510
|
+
|
|
511
|
+
export interface AppUserResponsesDTO {
|
|
512
|
+
responses: Array<AppUserResponseRowDTO>;
|
|
513
|
+
survey_id: string;
|
|
514
|
+
}
|
|
515
|
+
|
|
516
|
+
export interface CompanyContactScoreDTO {
|
|
517
|
+
classification?: string | null;
|
|
518
|
+
contact_id: number;
|
|
519
|
+
first_name?: string | null;
|
|
520
|
+
history?: Array<SurveyScorePointDTO>;
|
|
521
|
+
last_name?: string | null;
|
|
522
|
+
last_responded_at?: string | null;
|
|
523
|
+
responded?: boolean;
|
|
524
|
+
score?: number | null;
|
|
525
|
+
trend?: string | null;
|
|
526
|
+
}
|
|
527
|
+
|
|
528
|
+
export interface CompanyNpsDTO {
|
|
529
|
+
bucket: string;
|
|
530
|
+
company_id: number;
|
|
531
|
+
contacts: Array<CompanyContactScoreDTO>;
|
|
532
|
+
coverage: CoverageDTO;
|
|
533
|
+
detractors: number;
|
|
534
|
+
nps_score?: number | null;
|
|
535
|
+
passives: number;
|
|
536
|
+
promoters: number;
|
|
537
|
+
suppressed: boolean;
|
|
538
|
+
time_series: Array<TrendBarDTO>;
|
|
539
|
+
total_respondents: number;
|
|
540
|
+
}
|
|
541
|
+
|
|
542
|
+
export interface ContactHistoryDTO {
|
|
543
|
+
contact_id: number;
|
|
544
|
+
responses: Array<ContactHistoryItemDTO>;
|
|
545
|
+
}
|
|
546
|
+
|
|
547
|
+
export interface ContactHistoryItemDTO {
|
|
548
|
+
channel?: string | null;
|
|
549
|
+
classification?: string | null;
|
|
550
|
+
responded_at?: string | null;
|
|
551
|
+
score: number;
|
|
552
|
+
survey_id: string;
|
|
553
|
+
survey_name?: string | null;
|
|
554
|
+
type: string;
|
|
555
|
+
}
|
|
556
|
+
|
|
557
|
+
export interface CoverageDTO {
|
|
558
|
+
rate: number;
|
|
559
|
+
responded: number;
|
|
560
|
+
total_contacts: number;
|
|
561
|
+
}
|
|
562
|
+
|
|
563
|
+
export interface CreateSurveyRequest {
|
|
564
|
+
comment_mode?: string | null;
|
|
565
|
+
delivery_channel?: string;
|
|
566
|
+
name: string;
|
|
567
|
+
question_text: string;
|
|
568
|
+
scale_max?: number | null;
|
|
569
|
+
scale_min?: number | null;
|
|
570
|
+
template_id?: number | null;
|
|
571
|
+
thank_you_copy?: string | null;
|
|
572
|
+
type: string;
|
|
573
|
+
}
|
|
574
|
+
|
|
575
|
+
/**
|
|
576
|
+
* Configure an automated-send binding (Phase 3, RFC §5).
|
|
577
|
+
*
|
|
578
|
+
* - ``scheduled`` : requires ``audience_ref`` + ``cadence_days`` (30/60/90).
|
|
579
|
+
* - ``list_entry`` : requires ``audience_ref`` (the watch list).
|
|
580
|
+
* - ``stage_entry``: requires ``stage_value`` (the to_stage slug).
|
|
581
|
+
*/
|
|
582
|
+
export interface CreateSurveyTriggerRequest {
|
|
583
|
+
audience_ref?: string | null;
|
|
584
|
+
cadence_days?: number | null;
|
|
585
|
+
reply_to?: string | null;
|
|
586
|
+
sender_email: string;
|
|
587
|
+
sender_name?: string | null;
|
|
588
|
+
stage_value?: string | null;
|
|
589
|
+
subject: string;
|
|
590
|
+
trigger_kind: string;
|
|
591
|
+
}
|
|
592
|
+
|
|
593
|
+
export interface OrgCsatBlockDTO {
|
|
594
|
+
csat_avg?: number | null;
|
|
595
|
+
total_respondents: number;
|
|
596
|
+
}
|
|
597
|
+
|
|
598
|
+
export interface OrgNpsBlockDTO {
|
|
599
|
+
detractors: number;
|
|
600
|
+
nps_score?: number | null;
|
|
601
|
+
passives: number;
|
|
602
|
+
promoters: number;
|
|
603
|
+
total_respondents: number;
|
|
604
|
+
}
|
|
605
|
+
|
|
606
|
+
export interface OrgSummaryDTO {
|
|
607
|
+
bucket: string;
|
|
608
|
+
in_app_csat_avg?: number | null;
|
|
609
|
+
in_app_respondents?: number;
|
|
610
|
+
org_csat: OrgCsatBlockDTO;
|
|
611
|
+
org_nps: OrgNpsBlockDTO;
|
|
612
|
+
per_survey: Array<PerSurveyDTO>;
|
|
613
|
+
segment?: string | null;
|
|
614
|
+
time_series: Array<TrendBarDTO>;
|
|
615
|
+
}
|
|
616
|
+
|
|
617
|
+
export interface PaginationMeta {
|
|
618
|
+
/** Whether there are more pages */
|
|
619
|
+
has_next: boolean;
|
|
620
|
+
/** Items per page */
|
|
621
|
+
limit: number;
|
|
622
|
+
/** 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. */
|
|
623
|
+
next_cursor?: string | null;
|
|
624
|
+
/** Current page number (1-indexed) */
|
|
625
|
+
page: number;
|
|
626
|
+
/** Total number of items */
|
|
627
|
+
total: number;
|
|
628
|
+
}
|
|
629
|
+
|
|
630
|
+
export interface PerSurveyDTO {
|
|
631
|
+
audience_count?: number | null;
|
|
632
|
+
audience_name?: string | null;
|
|
633
|
+
audience_ref?: string | null;
|
|
634
|
+
cadence_days?: number | null;
|
|
635
|
+
cadence_kind?: string | null;
|
|
636
|
+
cadence_label?: string | null;
|
|
637
|
+
csat_avg?: number | null;
|
|
638
|
+
delivery_channel?: string | null;
|
|
639
|
+
detractors: number;
|
|
640
|
+
is_active?: boolean;
|
|
641
|
+
name?: string | null;
|
|
642
|
+
nps_score?: number | null;
|
|
643
|
+
passives: number;
|
|
644
|
+
promoters: number;
|
|
645
|
+
sent_count?: number;
|
|
646
|
+
status?: string | null;
|
|
647
|
+
survey_id: string;
|
|
648
|
+
total_respondents: number;
|
|
649
|
+
trend?: Array<TrendBarDTO>;
|
|
650
|
+
type: string;
|
|
651
|
+
}
|
|
652
|
+
|
|
653
|
+
export interface ResponseRateDTO {
|
|
654
|
+
rate: number;
|
|
655
|
+
responded: number;
|
|
656
|
+
sent: number;
|
|
657
|
+
}
|
|
658
|
+
|
|
659
|
+
export interface SendDeliveryBreakdownDTO {
|
|
660
|
+
bounced?: number;
|
|
661
|
+
delivered?: number;
|
|
662
|
+
failed?: number;
|
|
663
|
+
opened?: number;
|
|
664
|
+
pending?: number;
|
|
665
|
+
sent?: number;
|
|
666
|
+
}
|
|
667
|
+
|
|
668
|
+
export interface SendSurveyRequest {
|
|
669
|
+
audience_ref: string;
|
|
670
|
+
channel?: string;
|
|
671
|
+
reply_to?: string | null;
|
|
672
|
+
scheduled_at?: string | null;
|
|
673
|
+
sender_email?: string | null;
|
|
674
|
+
sender_name?: string | null;
|
|
675
|
+
subject?: string | null;
|
|
676
|
+
}
|
|
677
|
+
|
|
678
|
+
export interface SummaryDTO {
|
|
679
|
+
bucket: string;
|
|
680
|
+
csat_avg?: number | null;
|
|
681
|
+
delivery_channel: string;
|
|
682
|
+
detractors: number;
|
|
683
|
+
dissatisfied?: number | null;
|
|
684
|
+
neutral?: number | null;
|
|
685
|
+
nps_score?: number | null;
|
|
686
|
+
passives: number;
|
|
687
|
+
promoters: number;
|
|
688
|
+
response_rate: ResponseRateDTO;
|
|
689
|
+
satisfied?: number | null;
|
|
690
|
+
survey_id: string;
|
|
691
|
+
time_series: Array<TrendBarDTO>;
|
|
692
|
+
total_respondents: number;
|
|
693
|
+
type: string;
|
|
694
|
+
}
|
|
695
|
+
|
|
696
|
+
export interface SurveyDeleteResponse {
|
|
697
|
+
deleted: boolean;
|
|
698
|
+
survey_id: string;
|
|
699
|
+
}
|
|
700
|
+
|
|
701
|
+
/**
|
|
702
|
+
* An open envelope for a verification result.
|
|
703
|
+
*
|
|
704
|
+
* Open because the DNS record set grows: DMARC was added to it after SPF and
|
|
705
|
+
* DKIM, and closing the shape would have silently dropped the record that
|
|
706
|
+
* decides whether Gmail accepts the mail at all.
|
|
707
|
+
*/
|
|
708
|
+
export type SurveyDomainPayload = Record<string, unknown>;
|
|
709
|
+
|
|
710
|
+
export interface SurveyResponseDTO {
|
|
711
|
+
comment_mode?: string | null;
|
|
712
|
+
created_at?: string | null;
|
|
713
|
+
delivery_channel: string;
|
|
714
|
+
id: string;
|
|
715
|
+
is_active: boolean;
|
|
716
|
+
name: string;
|
|
717
|
+
question_text: string;
|
|
718
|
+
scale_max: number;
|
|
719
|
+
scale_min: number;
|
|
720
|
+
score_field_column_id?: string | null;
|
|
721
|
+
template_id?: number | null;
|
|
722
|
+
thank_you_copy?: string | null;
|
|
723
|
+
type: string;
|
|
724
|
+
}
|
|
725
|
+
|
|
726
|
+
export interface SurveyResponseRowDTO {
|
|
727
|
+
channel?: string | null;
|
|
728
|
+
classification?: string | null;
|
|
729
|
+
comment?: string | null;
|
|
730
|
+
contact_id: number;
|
|
731
|
+
first_name?: string | null;
|
|
732
|
+
history?: Array<SurveyScorePointDTO>;
|
|
733
|
+
last_name?: string | null;
|
|
734
|
+
responded_at?: string | null;
|
|
735
|
+
response_count?: number;
|
|
736
|
+
score: number;
|
|
737
|
+
trend?: string | null;
|
|
738
|
+
}
|
|
739
|
+
|
|
740
|
+
export interface SurveyResponsesDTO {
|
|
741
|
+
responses: Array<SurveyResponseRowDTO>;
|
|
742
|
+
survey_id: string;
|
|
743
|
+
}
|
|
744
|
+
|
|
745
|
+
export interface SurveyScorePointDTO {
|
|
746
|
+
responded_at?: string | null;
|
|
747
|
+
score: number;
|
|
748
|
+
send_id?: number | null;
|
|
749
|
+
}
|
|
750
|
+
|
|
751
|
+
/** A send that has been accepted for dispatch, not yet delivered. */
|
|
752
|
+
export interface SurveySendAccepted {
|
|
753
|
+
/** Contacts resolved from the audience at accept time. */
|
|
754
|
+
recipient_count: number;
|
|
755
|
+
/** Poll GET /surveys/sends/{send_id} for progress. */
|
|
756
|
+
send_id: number;
|
|
757
|
+
/** Dispatch state, e.g. queued or scheduled. */
|
|
758
|
+
status: string;
|
|
759
|
+
}
|
|
760
|
+
|
|
761
|
+
export interface SurveySendDTO {
|
|
762
|
+
audience_ref?: string | null;
|
|
763
|
+
channel: string;
|
|
764
|
+
id: number;
|
|
765
|
+
recipient_count: number;
|
|
766
|
+
scheduled_at?: string | null;
|
|
767
|
+
status: string;
|
|
768
|
+
survey_id: string;
|
|
769
|
+
}
|
|
770
|
+
|
|
771
|
+
export interface SurveySendRowDTO {
|
|
772
|
+
audience_name?: string | null;
|
|
773
|
+
audience_ref?: string | null;
|
|
774
|
+
channel: string;
|
|
775
|
+
created_at?: string | null;
|
|
776
|
+
delivery_breakdown: SendDeliveryBreakdownDTO;
|
|
777
|
+
id: number;
|
|
778
|
+
recipient_count?: number;
|
|
779
|
+
responded_count?: number;
|
|
780
|
+
scheduled_at?: string | null;
|
|
781
|
+
status: string;
|
|
782
|
+
trigger_kind?: string | null;
|
|
783
|
+
}
|
|
784
|
+
|
|
785
|
+
export interface SurveySendingDomainDTO {
|
|
786
|
+
domain: string;
|
|
787
|
+
id: number;
|
|
788
|
+
status: "verified" | "pending" | "not_set_up";
|
|
789
|
+
}
|
|
790
|
+
|
|
791
|
+
export interface SurveySendsDTO {
|
|
792
|
+
sends: Array<SurveySendRowDTO>;
|
|
793
|
+
survey_id: string;
|
|
794
|
+
}
|
|
795
|
+
|
|
796
|
+
export interface SurveyTriggerDTO {
|
|
797
|
+
audience_ref?: string | null;
|
|
798
|
+
cadence_days?: number | null;
|
|
799
|
+
id: string;
|
|
800
|
+
is_active: boolean;
|
|
801
|
+
reply_to?: string | null;
|
|
802
|
+
sender_email: string;
|
|
803
|
+
sender_name?: string | null;
|
|
804
|
+
stage_value?: string | null;
|
|
805
|
+
subject: string;
|
|
806
|
+
survey_id: string;
|
|
807
|
+
trigger_kind: string;
|
|
808
|
+
}
|
|
809
|
+
|
|
810
|
+
export interface SurveyTriggerDeleteResponse {
|
|
811
|
+
deleted: boolean;
|
|
812
|
+
survey_id?: string | null;
|
|
813
|
+
trigger_id: string;
|
|
814
|
+
}
|
|
815
|
+
|
|
816
|
+
export interface TrendBarDTO {
|
|
817
|
+
csat_avg?: number | null;
|
|
818
|
+
detractors: number;
|
|
819
|
+
nps_score?: number | null;
|
|
820
|
+
passives: number;
|
|
821
|
+
period: string;
|
|
822
|
+
promoters: number;
|
|
823
|
+
total: number;
|
|
824
|
+
}
|
|
825
|
+
|
|
826
|
+
export interface TrendsDTO {
|
|
827
|
+
bars: Array<TrendBarDTO>;
|
|
828
|
+
bucket: string;
|
|
829
|
+
delivery_channel: string;
|
|
830
|
+
survey_id: string;
|
|
831
|
+
type: string;
|
|
832
|
+
}
|
|
833
|
+
|
|
834
|
+
export interface UpdateSurveyRequest {
|
|
835
|
+
delivery_channel?: string | null;
|
|
836
|
+
is_active?: boolean | null;
|
|
837
|
+
name?: string | null;
|
|
838
|
+
question_text?: string | null;
|
|
839
|
+
template_id?: number | null;
|
|
840
|
+
thank_you_copy?: string | null;
|
|
841
|
+
}
|
|
842
|
+
|
|
843
|
+
/** Start verification of a survey sending domain. */
|
|
844
|
+
export interface VerifySurveyDomainRequest {
|
|
845
|
+
/** The sending domain or subdomain, e.g. `feedback.acme.com`. */
|
|
846
|
+
domain: string;
|
|
847
|
+
}
|