@graph8/sdk 0.245.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 +19 -5
- package/dist/cli.js +216 -0
- package/dist/index.d.mts +283 -12
- package/dist/index.d.ts +283 -12
- package/dist/index.js +88 -2
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +88 -2
- package/dist/index.mjs.map +1 -1
- package/dist/react.d.mts +274 -12
- package/dist/react.d.ts +274 -12
- package/dist/react.js +106 -10
- package/dist/react.js.map +1 -1
- package/dist/react.mjs +97 -11
- 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,784 @@
|
|
|
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.teams` (Teams): 35 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<"add_team_agent_teams__team_id__agents_post">;
|
|
9
|
+
*
|
|
10
|
+
* Reference with examples: teams.md
|
|
11
|
+
*/
|
|
12
|
+
/* eslint-disable */
|
|
13
|
+
|
|
14
|
+
/** `g8.api.teams.<member>` -> the operationId it calls. */
|
|
15
|
+
export interface TeamsMembers {
|
|
16
|
+
addTeamAgent: "add_team_agent_teams__team_id__agents_post";
|
|
17
|
+
addTeamMember: "add_team_member_teams__team_id__members_post";
|
|
18
|
+
assignCampaignToTeam: "assign_campaign_to_team_teams__team_id__campaigns_post";
|
|
19
|
+
assignLinkedinAccountToTeam: "assign_linkedin_account_to_team_teams__team_id__linkedin_accounts_post";
|
|
20
|
+
assignMailboxToTeam: "assign_mailbox_to_team_teams__team_id__mailboxes_post";
|
|
21
|
+
assignPhoneToTeam: "assign_phone_to_team_teams__team_id__phone_numbers_post";
|
|
22
|
+
autoComposeSuggest: "auto_compose_suggest_teams_auto_compose_suggest_post";
|
|
23
|
+
createTeam: "create_team_teams_post";
|
|
24
|
+
deleteTeam: "delete_team_teams__team_id__delete";
|
|
25
|
+
getTeam: "get_team_teams__team_id__get";
|
|
26
|
+
listAvailableAgents: "list_available_agents_teams_available_agents_get";
|
|
27
|
+
listAvailableCampaigns: "list_available_campaigns_teams_available_campaigns_get";
|
|
28
|
+
listAvailableChatbots: "list_available_chatbots_teams_available_chatbots_get";
|
|
29
|
+
listAvailableLinkedinAccounts: "list_available_linkedin_accounts_teams_available_linkedin_accounts_get";
|
|
30
|
+
listAvailableMailboxes: "list_available_mailboxes_teams_available_mailboxes_get";
|
|
31
|
+
listAvailablePhoneNumbers: "list_available_phone_numbers_teams_available_phone_numbers_get";
|
|
32
|
+
listAvailableSequences: "list_available_sequences_teams_available_sequences_get";
|
|
33
|
+
listTeamAgents: "list_team_agents_teams__team_id__agents_get";
|
|
34
|
+
listTeamCampaigns: "list_team_campaigns_teams__team_id__campaigns_get";
|
|
35
|
+
listTeamChatbots: "list_team_chatbots_teams__team_id__chatbots_get";
|
|
36
|
+
listTeamLinkedinAccounts: "list_team_linkedin_accounts_teams__team_id__linkedin_accounts_get";
|
|
37
|
+
listTeamMailboxes: "list_team_mailboxes_teams__team_id__mailboxes_get";
|
|
38
|
+
listTeamPhoneNumbers: "list_team_phone_numbers_teams__team_id__phone_numbers_get";
|
|
39
|
+
listTeamSequences: "list_team_sequences_teams__team_id__sequences_get";
|
|
40
|
+
listTeams: "list_teams_teams_get";
|
|
41
|
+
removeTeamAgent: "remove_team_agent_teams__team_id__agents__user_id__delete";
|
|
42
|
+
removeTeamMember: "remove_team_member_teams__team_id__members__user_id__delete";
|
|
43
|
+
unassignCampaignFromTeam: "unassign_campaign_from_team_teams__team_id__campaigns__campaign_id__delete";
|
|
44
|
+
unassignLinkedinAccountByAssoc: "unassign_linkedin_account_by_assoc_teams__team_id__linkedin_accounts_assoc__assoc_id__delete";
|
|
45
|
+
unassignLinkedinAccountFromTeam: "unassign_linkedin_account_from_team_teams__team_id__linkedin_accounts__linkedin_account_id__delete";
|
|
46
|
+
unassignMailboxFromTeam: "unassign_mailbox_from_team_teams__team_id__mailboxes__mailbox_id__delete";
|
|
47
|
+
unassignPhoneFromTeam: "unassign_phone_from_team_teams__team_id__phone_numbers__phone_id__delete";
|
|
48
|
+
updateTeam: "update_team_teams__team_id__put";
|
|
49
|
+
updateTeamAgentRole: "update_team_agent_role_teams__team_id__agents__user_id__patch";
|
|
50
|
+
updateTeamMemberRole: "update_team_member_role_teams__team_id__members__user_id__put";
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
/** Input and output of every `g8.api.teams` operation, keyed by operationId. */
|
|
54
|
+
export interface TeamsOperations {
|
|
55
|
+
/**
|
|
56
|
+
* POST /teams/{team_id}/agents
|
|
57
|
+
* Add Team Agent
|
|
58
|
+
* tier: write · scope: team:write
|
|
59
|
+
*/
|
|
60
|
+
add_team_agent_teams__team_id__agents_post: {
|
|
61
|
+
input: {
|
|
62
|
+
path: {
|
|
63
|
+
/** Team id (UUID). */
|
|
64
|
+
team_id: string;
|
|
65
|
+
};
|
|
66
|
+
headers?: {
|
|
67
|
+
"X-Target-Org-Id"?: string | null;
|
|
68
|
+
};
|
|
69
|
+
body: TeamMemberAddRequest;
|
|
70
|
+
};
|
|
71
|
+
output: ApiResponse_OrgPayload_;
|
|
72
|
+
};
|
|
73
|
+
/**
|
|
74
|
+
* POST /teams/{team_id}/members
|
|
75
|
+
* Add Team Member
|
|
76
|
+
* tier: write · scope: team:write
|
|
77
|
+
*/
|
|
78
|
+
add_team_member_teams__team_id__members_post: {
|
|
79
|
+
input: {
|
|
80
|
+
path: {
|
|
81
|
+
/** Team id (UUID). */
|
|
82
|
+
team_id: string;
|
|
83
|
+
};
|
|
84
|
+
headers?: {
|
|
85
|
+
"X-Target-Org-Id"?: string | null;
|
|
86
|
+
};
|
|
87
|
+
body: TeamMemberAddRequest;
|
|
88
|
+
};
|
|
89
|
+
output: ApiResponse_OrgPayload_;
|
|
90
|
+
};
|
|
91
|
+
/**
|
|
92
|
+
* POST /teams/{team_id}/campaigns
|
|
93
|
+
* Assign Campaign To Team
|
|
94
|
+
* tier: write · scope: team:write
|
|
95
|
+
*/
|
|
96
|
+
assign_campaign_to_team_teams__team_id__campaigns_post: {
|
|
97
|
+
input: {
|
|
98
|
+
path: {
|
|
99
|
+
/** Team id (UUID). */
|
|
100
|
+
team_id: string;
|
|
101
|
+
};
|
|
102
|
+
headers?: {
|
|
103
|
+
"X-Target-Org-Id"?: string | null;
|
|
104
|
+
};
|
|
105
|
+
body: AssignTeamCampaignRequest;
|
|
106
|
+
};
|
|
107
|
+
output: ApiResponse_OrgPayload_;
|
|
108
|
+
};
|
|
109
|
+
/**
|
|
110
|
+
* POST /teams/{team_id}/linkedin-accounts
|
|
111
|
+
* Assign Linkedin Account To Team
|
|
112
|
+
* tier: write · scope: team:write
|
|
113
|
+
*/
|
|
114
|
+
assign_linkedin_account_to_team_teams__team_id__linkedin_accounts_post: {
|
|
115
|
+
input: {
|
|
116
|
+
path: {
|
|
117
|
+
/** Team id (UUID). */
|
|
118
|
+
team_id: string;
|
|
119
|
+
};
|
|
120
|
+
headers?: {
|
|
121
|
+
"X-Target-Org-Id"?: string | null;
|
|
122
|
+
};
|
|
123
|
+
body: AssignLinkedInAccountRequest;
|
|
124
|
+
};
|
|
125
|
+
output: ApiResponse_OrgPayload_;
|
|
126
|
+
};
|
|
127
|
+
/**
|
|
128
|
+
* POST /teams/{team_id}/mailboxes
|
|
129
|
+
* Assign Mailbox To Team
|
|
130
|
+
* tier: write · scope: team:write
|
|
131
|
+
*/
|
|
132
|
+
assign_mailbox_to_team_teams__team_id__mailboxes_post: {
|
|
133
|
+
input: {
|
|
134
|
+
path: {
|
|
135
|
+
/** Team id (UUID). */
|
|
136
|
+
team_id: string;
|
|
137
|
+
};
|
|
138
|
+
headers?: {
|
|
139
|
+
"X-Target-Org-Id"?: string | null;
|
|
140
|
+
};
|
|
141
|
+
body: AssignObjectRequest;
|
|
142
|
+
};
|
|
143
|
+
output: ApiResponse_OrgPayload_;
|
|
144
|
+
};
|
|
145
|
+
/**
|
|
146
|
+
* POST /teams/{team_id}/phone-numbers
|
|
147
|
+
* Assign Phone To Team
|
|
148
|
+
* tier: write · scope: team:write
|
|
149
|
+
*/
|
|
150
|
+
assign_phone_to_team_teams__team_id__phone_numbers_post: {
|
|
151
|
+
input: {
|
|
152
|
+
path: {
|
|
153
|
+
/** Team id (UUID). */
|
|
154
|
+
team_id: string;
|
|
155
|
+
};
|
|
156
|
+
headers?: {
|
|
157
|
+
"X-Target-Org-Id"?: string | null;
|
|
158
|
+
};
|
|
159
|
+
body: AssignObjectRequest;
|
|
160
|
+
};
|
|
161
|
+
output: ApiResponse_OrgPayload_;
|
|
162
|
+
};
|
|
163
|
+
/**
|
|
164
|
+
* POST /teams/auto-compose/suggest
|
|
165
|
+
* Auto Compose Suggest
|
|
166
|
+
* tier: billable · scope: team:run
|
|
167
|
+
*/
|
|
168
|
+
auto_compose_suggest_teams_auto_compose_suggest_post: {
|
|
169
|
+
input: {
|
|
170
|
+
headers?: {
|
|
171
|
+
"X-Target-Org-Id"?: string | null;
|
|
172
|
+
};
|
|
173
|
+
};
|
|
174
|
+
output: ApiResponse_OrgPayload_;
|
|
175
|
+
};
|
|
176
|
+
/**
|
|
177
|
+
* POST /teams
|
|
178
|
+
* Create Team
|
|
179
|
+
* tier: write · scope: team:write
|
|
180
|
+
*/
|
|
181
|
+
create_team_teams_post: {
|
|
182
|
+
input: {
|
|
183
|
+
headers?: {
|
|
184
|
+
"X-Target-Org-Id"?: string | null;
|
|
185
|
+
};
|
|
186
|
+
body: TeamCreateRequest;
|
|
187
|
+
};
|
|
188
|
+
output: ApiResponse_OrgPayload_;
|
|
189
|
+
};
|
|
190
|
+
/**
|
|
191
|
+
* DELETE /teams/{team_id}
|
|
192
|
+
* Delete Team
|
|
193
|
+
* tier: destructive · scope: team:delete
|
|
194
|
+
*/
|
|
195
|
+
delete_team_teams__team_id__delete: {
|
|
196
|
+
input: {
|
|
197
|
+
path: {
|
|
198
|
+
/** Team id (UUID). */
|
|
199
|
+
team_id: string;
|
|
200
|
+
};
|
|
201
|
+
headers?: {
|
|
202
|
+
"X-Target-Org-Id"?: string | null;
|
|
203
|
+
};
|
|
204
|
+
};
|
|
205
|
+
output: ApiResponse_OrgPayload_;
|
|
206
|
+
};
|
|
207
|
+
/**
|
|
208
|
+
* GET /teams/{team_id}
|
|
209
|
+
* Get Team
|
|
210
|
+
* tier: read · scope: team:read
|
|
211
|
+
*/
|
|
212
|
+
get_team_teams__team_id__get: {
|
|
213
|
+
input: {
|
|
214
|
+
path: {
|
|
215
|
+
/** Team id (UUID). */
|
|
216
|
+
team_id: string;
|
|
217
|
+
};
|
|
218
|
+
headers?: {
|
|
219
|
+
"X-Target-Org-Id"?: string | null;
|
|
220
|
+
};
|
|
221
|
+
};
|
|
222
|
+
output: ApiResponse_OrgPayload_;
|
|
223
|
+
};
|
|
224
|
+
/**
|
|
225
|
+
* GET /teams/available/agents
|
|
226
|
+
* List Available Agents
|
|
227
|
+
* tier: read · scope: team:read
|
|
228
|
+
*/
|
|
229
|
+
list_available_agents_teams_available_agents_get: {
|
|
230
|
+
input: {
|
|
231
|
+
headers?: {
|
|
232
|
+
"X-Target-Org-Id"?: string | null;
|
|
233
|
+
};
|
|
234
|
+
};
|
|
235
|
+
output: ApiResponse_OrgListPayload_;
|
|
236
|
+
};
|
|
237
|
+
/**
|
|
238
|
+
* GET /teams/available/campaigns
|
|
239
|
+
* List Available Campaigns
|
|
240
|
+
* tier: read · scope: team:read
|
|
241
|
+
*/
|
|
242
|
+
list_available_campaigns_teams_available_campaigns_get: {
|
|
243
|
+
input: {
|
|
244
|
+
headers?: {
|
|
245
|
+
"X-Target-Org-Id"?: string | null;
|
|
246
|
+
};
|
|
247
|
+
};
|
|
248
|
+
output: ApiResponse_OrgListPayload_;
|
|
249
|
+
};
|
|
250
|
+
/**
|
|
251
|
+
* GET /teams/available/chatbots
|
|
252
|
+
* List Available Chatbots
|
|
253
|
+
* tier: read · scope: team:read
|
|
254
|
+
*/
|
|
255
|
+
list_available_chatbots_teams_available_chatbots_get: {
|
|
256
|
+
input: {
|
|
257
|
+
headers?: {
|
|
258
|
+
"X-Target-Org-Id"?: string | null;
|
|
259
|
+
};
|
|
260
|
+
};
|
|
261
|
+
output: ApiResponse_OrgListPayload_;
|
|
262
|
+
};
|
|
263
|
+
/**
|
|
264
|
+
* GET /teams/available/linkedin-accounts
|
|
265
|
+
* List Available Linkedin Accounts
|
|
266
|
+
* tier: read · scope: team:read
|
|
267
|
+
*/
|
|
268
|
+
list_available_linkedin_accounts_teams_available_linkedin_accounts_get: {
|
|
269
|
+
input: {
|
|
270
|
+
headers?: {
|
|
271
|
+
"X-Target-Org-Id"?: string | null;
|
|
272
|
+
};
|
|
273
|
+
};
|
|
274
|
+
output: ApiResponse_OrgListPayload_;
|
|
275
|
+
};
|
|
276
|
+
/**
|
|
277
|
+
* GET /teams/available/mailboxes
|
|
278
|
+
* List Available Mailboxes
|
|
279
|
+
* tier: read · scope: team:read
|
|
280
|
+
*/
|
|
281
|
+
list_available_mailboxes_teams_available_mailboxes_get: {
|
|
282
|
+
input: {
|
|
283
|
+
headers?: {
|
|
284
|
+
"X-Target-Org-Id"?: string | null;
|
|
285
|
+
};
|
|
286
|
+
};
|
|
287
|
+
output: ApiResponse_OrgListPayload_;
|
|
288
|
+
};
|
|
289
|
+
/**
|
|
290
|
+
* GET /teams/available/phone-numbers
|
|
291
|
+
* List Available Phone Numbers
|
|
292
|
+
* tier: read · scope: team:read
|
|
293
|
+
*/
|
|
294
|
+
list_available_phone_numbers_teams_available_phone_numbers_get: {
|
|
295
|
+
input: {
|
|
296
|
+
headers?: {
|
|
297
|
+
"X-Target-Org-Id"?: string | null;
|
|
298
|
+
};
|
|
299
|
+
};
|
|
300
|
+
output: ApiResponse_OrgListPayload_;
|
|
301
|
+
};
|
|
302
|
+
/**
|
|
303
|
+
* GET /teams/available/sequences
|
|
304
|
+
* List Available Sequences
|
|
305
|
+
* tier: read · scope: team:read
|
|
306
|
+
*/
|
|
307
|
+
list_available_sequences_teams_available_sequences_get: {
|
|
308
|
+
input: {
|
|
309
|
+
headers?: {
|
|
310
|
+
"X-Target-Org-Id"?: string | null;
|
|
311
|
+
};
|
|
312
|
+
};
|
|
313
|
+
output: ApiResponse_OrgListPayload_;
|
|
314
|
+
};
|
|
315
|
+
/**
|
|
316
|
+
* GET /teams/{team_id}/agents
|
|
317
|
+
* List Team Agents
|
|
318
|
+
* tier: read · scope: team:read
|
|
319
|
+
*/
|
|
320
|
+
list_team_agents_teams__team_id__agents_get: {
|
|
321
|
+
input: {
|
|
322
|
+
path: {
|
|
323
|
+
/** Team id (UUID). */
|
|
324
|
+
team_id: string;
|
|
325
|
+
};
|
|
326
|
+
headers?: {
|
|
327
|
+
"X-Target-Org-Id"?: string | null;
|
|
328
|
+
};
|
|
329
|
+
};
|
|
330
|
+
output: ApiResponse_OrgListPayload_;
|
|
331
|
+
};
|
|
332
|
+
/**
|
|
333
|
+
* GET /teams/{team_id}/campaigns
|
|
334
|
+
* List Team Campaigns
|
|
335
|
+
* tier: read · scope: team:read
|
|
336
|
+
*/
|
|
337
|
+
list_team_campaigns_teams__team_id__campaigns_get: {
|
|
338
|
+
input: {
|
|
339
|
+
path: {
|
|
340
|
+
/** Team id (UUID). */
|
|
341
|
+
team_id: string;
|
|
342
|
+
};
|
|
343
|
+
headers?: {
|
|
344
|
+
"X-Target-Org-Id"?: string | null;
|
|
345
|
+
};
|
|
346
|
+
};
|
|
347
|
+
output: ApiResponse_OrgListPayload_;
|
|
348
|
+
};
|
|
349
|
+
/**
|
|
350
|
+
* GET /teams/{team_id}/chatbots
|
|
351
|
+
* List Team Chatbots
|
|
352
|
+
* tier: read · scope: team:read
|
|
353
|
+
*/
|
|
354
|
+
list_team_chatbots_teams__team_id__chatbots_get: {
|
|
355
|
+
input: {
|
|
356
|
+
path: {
|
|
357
|
+
/** Team id (UUID). */
|
|
358
|
+
team_id: string;
|
|
359
|
+
};
|
|
360
|
+
headers?: {
|
|
361
|
+
"X-Target-Org-Id"?: string | null;
|
|
362
|
+
};
|
|
363
|
+
};
|
|
364
|
+
output: ApiResponse_OrgListPayload_;
|
|
365
|
+
};
|
|
366
|
+
/**
|
|
367
|
+
* GET /teams/{team_id}/linkedin-accounts
|
|
368
|
+
* List Team Linkedin Accounts
|
|
369
|
+
* tier: read · scope: team:read
|
|
370
|
+
*/
|
|
371
|
+
list_team_linkedin_accounts_teams__team_id__linkedin_accounts_get: {
|
|
372
|
+
input: {
|
|
373
|
+
path: {
|
|
374
|
+
/** Team id (UUID). */
|
|
375
|
+
team_id: string;
|
|
376
|
+
};
|
|
377
|
+
headers?: {
|
|
378
|
+
"X-Target-Org-Id"?: string | null;
|
|
379
|
+
};
|
|
380
|
+
};
|
|
381
|
+
output: ApiResponse_OrgListPayload_;
|
|
382
|
+
};
|
|
383
|
+
/**
|
|
384
|
+
* GET /teams/{team_id}/mailboxes
|
|
385
|
+
* List Team Mailboxes
|
|
386
|
+
* tier: read · scope: team:read
|
|
387
|
+
*/
|
|
388
|
+
list_team_mailboxes_teams__team_id__mailboxes_get: {
|
|
389
|
+
input: {
|
|
390
|
+
path: {
|
|
391
|
+
/** Team id (UUID). */
|
|
392
|
+
team_id: string;
|
|
393
|
+
};
|
|
394
|
+
headers?: {
|
|
395
|
+
"X-Target-Org-Id"?: string | null;
|
|
396
|
+
};
|
|
397
|
+
};
|
|
398
|
+
output: ApiResponse_OrgListPayload_;
|
|
399
|
+
};
|
|
400
|
+
/**
|
|
401
|
+
* GET /teams/{team_id}/phone-numbers
|
|
402
|
+
* List Team Phone Numbers
|
|
403
|
+
* tier: read · scope: team:read
|
|
404
|
+
*/
|
|
405
|
+
list_team_phone_numbers_teams__team_id__phone_numbers_get: {
|
|
406
|
+
input: {
|
|
407
|
+
path: {
|
|
408
|
+
/** Team id (UUID). */
|
|
409
|
+
team_id: string;
|
|
410
|
+
};
|
|
411
|
+
headers?: {
|
|
412
|
+
"X-Target-Org-Id"?: string | null;
|
|
413
|
+
};
|
|
414
|
+
};
|
|
415
|
+
output: ApiResponse_OrgListPayload_;
|
|
416
|
+
};
|
|
417
|
+
/**
|
|
418
|
+
* GET /teams/{team_id}/sequences
|
|
419
|
+
* List Team Sequences
|
|
420
|
+
* tier: read · scope: team:read
|
|
421
|
+
*/
|
|
422
|
+
list_team_sequences_teams__team_id__sequences_get: {
|
|
423
|
+
input: {
|
|
424
|
+
path: {
|
|
425
|
+
/** Team id (UUID). */
|
|
426
|
+
team_id: string;
|
|
427
|
+
};
|
|
428
|
+
headers?: {
|
|
429
|
+
"X-Target-Org-Id"?: string | null;
|
|
430
|
+
};
|
|
431
|
+
};
|
|
432
|
+
output: ApiResponse_OrgListPayload_;
|
|
433
|
+
};
|
|
434
|
+
/**
|
|
435
|
+
* GET /teams
|
|
436
|
+
* List Teams
|
|
437
|
+
* tier: read · scope: team:read
|
|
438
|
+
*/
|
|
439
|
+
list_teams_teams_get: {
|
|
440
|
+
input: {
|
|
441
|
+
headers?: {
|
|
442
|
+
"X-Target-Org-Id"?: string | null;
|
|
443
|
+
};
|
|
444
|
+
};
|
|
445
|
+
output: ApiResponse_OrgListPayload_;
|
|
446
|
+
};
|
|
447
|
+
/**
|
|
448
|
+
* DELETE /teams/{team_id}/agents/{user_id}
|
|
449
|
+
* Remove Team Agent
|
|
450
|
+
* tier: destructive · scope: team:delete
|
|
451
|
+
*/
|
|
452
|
+
remove_team_agent_teams__team_id__agents__user_id__delete: {
|
|
453
|
+
input: {
|
|
454
|
+
path: {
|
|
455
|
+
/** Team id (UUID). */
|
|
456
|
+
team_id: string;
|
|
457
|
+
/** Agent user id. */
|
|
458
|
+
user_id: string;
|
|
459
|
+
};
|
|
460
|
+
headers?: {
|
|
461
|
+
"X-Target-Org-Id"?: string | null;
|
|
462
|
+
};
|
|
463
|
+
};
|
|
464
|
+
output: ApiResponse_OrgPayload_;
|
|
465
|
+
};
|
|
466
|
+
/**
|
|
467
|
+
* DELETE /teams/{team_id}/members/{user_id}
|
|
468
|
+
* Remove Team Member
|
|
469
|
+
* tier: destructive · scope: team:delete
|
|
470
|
+
*/
|
|
471
|
+
remove_team_member_teams__team_id__members__user_id__delete: {
|
|
472
|
+
input: {
|
|
473
|
+
path: {
|
|
474
|
+
/** Team id (UUID). */
|
|
475
|
+
team_id: string;
|
|
476
|
+
/** Identity-provider user id. */
|
|
477
|
+
user_id: string;
|
|
478
|
+
};
|
|
479
|
+
headers?: {
|
|
480
|
+
"X-Target-Org-Id"?: string | null;
|
|
481
|
+
};
|
|
482
|
+
};
|
|
483
|
+
output: ApiResponse_OrgPayload_;
|
|
484
|
+
};
|
|
485
|
+
/**
|
|
486
|
+
* DELETE /teams/{team_id}/campaigns/{campaign_id}
|
|
487
|
+
* Unassign Campaign From Team
|
|
488
|
+
* tier: destructive · scope: team:delete
|
|
489
|
+
*/
|
|
490
|
+
unassign_campaign_from_team_teams__team_id__campaigns__campaign_id__delete: {
|
|
491
|
+
input: {
|
|
492
|
+
path: {
|
|
493
|
+
/** Team id (UUID). */
|
|
494
|
+
team_id: string;
|
|
495
|
+
/** Campaign id (UUID). */
|
|
496
|
+
campaign_id: string;
|
|
497
|
+
};
|
|
498
|
+
headers?: {
|
|
499
|
+
"X-Target-Org-Id"?: string | null;
|
|
500
|
+
};
|
|
501
|
+
};
|
|
502
|
+
output: ApiResponse_OrgPayload_;
|
|
503
|
+
};
|
|
504
|
+
/**
|
|
505
|
+
* DELETE /teams/{team_id}/linkedin-accounts/assoc/{assoc_id}
|
|
506
|
+
* Unassign Linkedin Account By Assoc
|
|
507
|
+
* tier: destructive · scope: team:delete
|
|
508
|
+
*/
|
|
509
|
+
unassign_linkedin_account_by_assoc_teams__team_id__linkedin_accounts_assoc__assoc_id__delete: {
|
|
510
|
+
input: {
|
|
511
|
+
path: {
|
|
512
|
+
/** Team id (UUID). */
|
|
513
|
+
team_id: string;
|
|
514
|
+
/** Association row id (UUID). */
|
|
515
|
+
assoc_id: string;
|
|
516
|
+
};
|
|
517
|
+
headers?: {
|
|
518
|
+
"X-Target-Org-Id"?: string | null;
|
|
519
|
+
};
|
|
520
|
+
};
|
|
521
|
+
output: ApiResponse_OrgPayload_;
|
|
522
|
+
};
|
|
523
|
+
/**
|
|
524
|
+
* DELETE /teams/{team_id}/linkedin-accounts/{linkedin_account_id}
|
|
525
|
+
* Unassign Linkedin Account From Team
|
|
526
|
+
* tier: destructive · scope: team:delete
|
|
527
|
+
*/
|
|
528
|
+
unassign_linkedin_account_from_team_teams__team_id__linkedin_accounts__linkedin_account_id__delete: {
|
|
529
|
+
input: {
|
|
530
|
+
path: {
|
|
531
|
+
/** Team id (UUID). */
|
|
532
|
+
team_id: string;
|
|
533
|
+
/** LinkedIn account id (UUID). */
|
|
534
|
+
linkedin_account_id: string;
|
|
535
|
+
};
|
|
536
|
+
headers?: {
|
|
537
|
+
"X-Target-Org-Id"?: string | null;
|
|
538
|
+
};
|
|
539
|
+
};
|
|
540
|
+
output: ApiResponse_OrgPayload_;
|
|
541
|
+
};
|
|
542
|
+
/**
|
|
543
|
+
* DELETE /teams/{team_id}/mailboxes/{mailbox_id}
|
|
544
|
+
* Unassign Mailbox From Team
|
|
545
|
+
* tier: destructive · scope: team:delete
|
|
546
|
+
*/
|
|
547
|
+
unassign_mailbox_from_team_teams__team_id__mailboxes__mailbox_id__delete: {
|
|
548
|
+
input: {
|
|
549
|
+
path: {
|
|
550
|
+
/** Team id (UUID). */
|
|
551
|
+
team_id: string;
|
|
552
|
+
/** Integer `mailboxes.id`. */
|
|
553
|
+
mailbox_id: number;
|
|
554
|
+
};
|
|
555
|
+
headers?: {
|
|
556
|
+
"X-Target-Org-Id"?: string | null;
|
|
557
|
+
};
|
|
558
|
+
};
|
|
559
|
+
output: ApiResponse_OrgPayload_;
|
|
560
|
+
};
|
|
561
|
+
/**
|
|
562
|
+
* DELETE /teams/{team_id}/phone-numbers/{phone_id}
|
|
563
|
+
* Unassign Phone From Team
|
|
564
|
+
* tier: destructive · scope: team:delete
|
|
565
|
+
*/
|
|
566
|
+
unassign_phone_from_team_teams__team_id__phone_numbers__phone_id__delete: {
|
|
567
|
+
input: {
|
|
568
|
+
path: {
|
|
569
|
+
/** Team id (UUID). */
|
|
570
|
+
team_id: string;
|
|
571
|
+
/** Integer phone-number id. */
|
|
572
|
+
phone_id: number;
|
|
573
|
+
};
|
|
574
|
+
headers?: {
|
|
575
|
+
"X-Target-Org-Id"?: string | null;
|
|
576
|
+
};
|
|
577
|
+
};
|
|
578
|
+
output: ApiResponse_OrgPayload_;
|
|
579
|
+
};
|
|
580
|
+
/**
|
|
581
|
+
* PUT /teams/{team_id}
|
|
582
|
+
* Update Team
|
|
583
|
+
* tier: write · scope: team:write
|
|
584
|
+
*/
|
|
585
|
+
update_team_teams__team_id__put: {
|
|
586
|
+
input: {
|
|
587
|
+
path: {
|
|
588
|
+
/** Team id (UUID). */
|
|
589
|
+
team_id: string;
|
|
590
|
+
};
|
|
591
|
+
headers?: {
|
|
592
|
+
"X-Target-Org-Id"?: string | null;
|
|
593
|
+
};
|
|
594
|
+
body: TeamUpdateRequest;
|
|
595
|
+
};
|
|
596
|
+
output: ApiResponse_OrgPayload_;
|
|
597
|
+
};
|
|
598
|
+
/**
|
|
599
|
+
* PATCH /teams/{team_id}/agents/{user_id}
|
|
600
|
+
* Update Team Agent Role
|
|
601
|
+
* tier: destructive · scope: team:delete
|
|
602
|
+
*/
|
|
603
|
+
update_team_agent_role_teams__team_id__agents__user_id__patch: {
|
|
604
|
+
input: {
|
|
605
|
+
path: {
|
|
606
|
+
/** Team id (UUID). */
|
|
607
|
+
team_id: string;
|
|
608
|
+
/** Agent user id. */
|
|
609
|
+
user_id: string;
|
|
610
|
+
};
|
|
611
|
+
headers?: {
|
|
612
|
+
"X-Target-Org-Id"?: string | null;
|
|
613
|
+
};
|
|
614
|
+
body: TeamMemberRoleUpdateRequest;
|
|
615
|
+
};
|
|
616
|
+
output: ApiResponse_OrgPayload_;
|
|
617
|
+
};
|
|
618
|
+
/**
|
|
619
|
+
* PUT /teams/{team_id}/members/{user_id}
|
|
620
|
+
* Update Team Member Role
|
|
621
|
+
* tier: destructive · scope: team:delete
|
|
622
|
+
*/
|
|
623
|
+
update_team_member_role_teams__team_id__members__user_id__put: {
|
|
624
|
+
input: {
|
|
625
|
+
path: {
|
|
626
|
+
/** Team id (UUID). */
|
|
627
|
+
team_id: string;
|
|
628
|
+
/** Identity-provider user id. */
|
|
629
|
+
user_id: string;
|
|
630
|
+
};
|
|
631
|
+
headers?: {
|
|
632
|
+
"X-Target-Org-Id"?: string | null;
|
|
633
|
+
};
|
|
634
|
+
body: TeamMemberRoleUpdateRequest;
|
|
635
|
+
};
|
|
636
|
+
output: ApiResponse_OrgPayload_;
|
|
637
|
+
};
|
|
638
|
+
}
|
|
639
|
+
|
|
640
|
+
// 13 schemas referenced above (the same as G8Contract.<Name>).
|
|
641
|
+
|
|
642
|
+
export interface ApiResponse_OrgListPayload_ {
|
|
643
|
+
data: OrgListPayload;
|
|
644
|
+
pagination?: PaginationMeta | null;
|
|
645
|
+
}
|
|
646
|
+
|
|
647
|
+
export interface ApiResponse_OrgPayload_ {
|
|
648
|
+
data: OrgPayload;
|
|
649
|
+
pagination?: PaginationMeta | null;
|
|
650
|
+
}
|
|
651
|
+
|
|
652
|
+
/**
|
|
653
|
+
* Attach a LinkedIn sending account. Mirrors `teams.AssignLinkedInAccountDTO`.
|
|
654
|
+
*
|
|
655
|
+
* All three fields are optional because two spellings are supported: the
|
|
656
|
+
* current `provider` + `account_ref` pair, and the legacy
|
|
657
|
+
* `linkedin_account_id`. The handler validates that one of them is usable.
|
|
658
|
+
*/
|
|
659
|
+
export interface AssignLinkedInAccountRequest {
|
|
660
|
+
/** The provider's own account key. */
|
|
661
|
+
account_ref?: string | null;
|
|
662
|
+
/** Legacy account id. */
|
|
663
|
+
linkedin_account_id?: string | null;
|
|
664
|
+
/** Which LinkedIn provider the account belongs to. */
|
|
665
|
+
provider?: string | null;
|
|
666
|
+
}
|
|
667
|
+
|
|
668
|
+
/** Attach a mailbox or a phone number. Mirrors `teams.AssignObjectDTO`. */
|
|
669
|
+
export interface AssignObjectRequest {
|
|
670
|
+
/** Integer id of the mailbox or phone number to attach. */
|
|
671
|
+
object_id: number;
|
|
672
|
+
}
|
|
673
|
+
|
|
674
|
+
/** Link a campaign to a team. Mirrors `teams.AssignTeamCampaignDTO`. */
|
|
675
|
+
export interface AssignTeamCampaignRequest {
|
|
676
|
+
/** UUID of the campaign to link to this team. */
|
|
677
|
+
campaign_id: string;
|
|
678
|
+
}
|
|
679
|
+
|
|
680
|
+
/**
|
|
681
|
+
* An open envelope for a LIST result, so a bare list keeps its shape.
|
|
682
|
+
*
|
|
683
|
+
* Most of these handlers return a bare `list[...]`; a few return a named
|
|
684
|
+
* envelope (`{"team_members": [...], "total": n}`). Both are reachable as
|
|
685
|
+
* `items`, and a named envelope KEEPS its own key as well so a caller
|
|
686
|
+
* already reading the app's shape is not broken by the wrapper.
|
|
687
|
+
*/
|
|
688
|
+
export interface OrgListPayload {
|
|
689
|
+
items?: Array<unknown>;
|
|
690
|
+
[key: string]: unknown;
|
|
691
|
+
}
|
|
692
|
+
|
|
693
|
+
/**
|
|
694
|
+
* An open envelope for a single role, team, member or account record.
|
|
695
|
+
*
|
|
696
|
+
* Open on purpose. The app's own response models on this surface grow with
|
|
697
|
+
* the product - `RoleResponse` gained `rep_limits` and `manages_role_slugs`,
|
|
698
|
+
* `TeamResponse` gained channel counts and a campaign count - and a pinned
|
|
699
|
+
* mirror would SILENTLY DROP whatever it had not caught up on. A dropped
|
|
700
|
+
* permission in a role read is the worst possible kind of stale: it reads as
|
|
701
|
+
* "they do not have it".
|
|
702
|
+
*/
|
|
703
|
+
export type OrgPayload = Record<string, unknown>;
|
|
704
|
+
|
|
705
|
+
export interface PaginationMeta {
|
|
706
|
+
/** Whether there are more pages */
|
|
707
|
+
has_next: boolean;
|
|
708
|
+
/** Items per page */
|
|
709
|
+
limit: number;
|
|
710
|
+
/** 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. */
|
|
711
|
+
next_cursor?: string | null;
|
|
712
|
+
/** Current page number (1-indexed) */
|
|
713
|
+
page: number;
|
|
714
|
+
/** Total number of items */
|
|
715
|
+
total: number;
|
|
716
|
+
}
|
|
717
|
+
|
|
718
|
+
/**
|
|
719
|
+
* Create a team. Mirrors `teams.TeamCreateDTO`.
|
|
720
|
+
*
|
|
721
|
+
* Every `*_ids` list is applied in the SAME transaction as the team row, so
|
|
722
|
+
* a team is never briefly visible with none of its channels attached.
|
|
723
|
+
*/
|
|
724
|
+
export interface TeamCreateRequest {
|
|
725
|
+
agent_id?: string | null;
|
|
726
|
+
campaign_ids?: Array<string> | null;
|
|
727
|
+
/** 'support' | 'sales' | null */
|
|
728
|
+
chat_intent?: string | null;
|
|
729
|
+
chatbot_ids?: Array<string> | null;
|
|
730
|
+
/** Hex colour, e.g. #FF5733. An empty string clears it. */
|
|
731
|
+
color?: string | null;
|
|
732
|
+
description?: string | null;
|
|
733
|
+
linkedin_account_ids?: Array<string> | null;
|
|
734
|
+
mailbox_ids?: Array<number> | null;
|
|
735
|
+
members?: Array<WorkspaceMemberInput> | null;
|
|
736
|
+
name: string;
|
|
737
|
+
phone_number_ids?: Array<number> | null;
|
|
738
|
+
sequence_ids?: Array<string> | null;
|
|
739
|
+
type?: string;
|
|
740
|
+
}
|
|
741
|
+
|
|
742
|
+
/** Put a person (or an agent) on a team. Mirrors `teams.TeamMemberAddDTO`. */
|
|
743
|
+
export interface TeamMemberAddRequest {
|
|
744
|
+
team_role?: string;
|
|
745
|
+
user_id: string;
|
|
746
|
+
}
|
|
747
|
+
|
|
748
|
+
/** Change someone's role WITHIN a team. Mirrors `teams.TeamMemberUpdateDTO`. */
|
|
749
|
+
export interface TeamMemberRoleUpdateRequest {
|
|
750
|
+
team_role: string;
|
|
751
|
+
}
|
|
752
|
+
|
|
753
|
+
/**
|
|
754
|
+
* Update a team. Mirrors `teams.TeamUpdateDTO`.
|
|
755
|
+
*
|
|
756
|
+
* An omitted `*_ids` list LEAVES that attachment alone; a list that is
|
|
757
|
+
* present REPLACES it (the handler diffs). Sending `[]` therefore detaches
|
|
758
|
+
* everything of that kind, which is not the same instruction as omitting it.
|
|
759
|
+
*/
|
|
760
|
+
export interface TeamUpdateRequest {
|
|
761
|
+
/** Single workspace AI agent; empty string clears it. */
|
|
762
|
+
agent_id?: string | null;
|
|
763
|
+
campaign_ids?: Array<string> | null;
|
|
764
|
+
/** 'support' | 'sales' | null. An empty string clears it. */
|
|
765
|
+
chat_intent?: string | null;
|
|
766
|
+
chatbot_ids?: Array<string> | null;
|
|
767
|
+
/** Hex colour, e.g. #FF5733. An empty string clears it. */
|
|
768
|
+
color?: string | null;
|
|
769
|
+
description?: string | null;
|
|
770
|
+
linkedin_account_ids?: Array<string> | null;
|
|
771
|
+
mailbox_ids?: Array<number> | null;
|
|
772
|
+
members?: Array<WorkspaceMemberInput> | null;
|
|
773
|
+
name?: string | null;
|
|
774
|
+
phone_number_ids?: Array<number> | null;
|
|
775
|
+
sequence_ids?: Array<string> | null;
|
|
776
|
+
type?: string | null;
|
|
777
|
+
}
|
|
778
|
+
|
|
779
|
+
/** One member in a team's single-save membership list. */
|
|
780
|
+
export interface WorkspaceMemberInput {
|
|
781
|
+
/** member | manager */
|
|
782
|
+
role?: "member" | "manager";
|
|
783
|
+
user_id: string;
|
|
784
|
+
}
|