@graph8/sdk 0.5.1 → 0.5.3

package/dist/index.d.mts

@@ -133,10 +133,13 @@ interface ResearchReport {
  *   GET /api/v1/research-reports
  */
 declare const createStudioClient: (apiKey: string, apiUrl?: string) => {
-    /** Org-level Studio documents (brand_brief, value_props, messaging_house, etc.). */
+    /** Org-level Studio documents (brand_brief, value_props, messaging_house, etc.).
+     * `include_content` defaults to true server-side, so each document includes
+     * its `content` body unless you explicitly pass `include_content: false`. */
     globalContext(params?: {
         category?: string;
         limit?: number;
+        include_content?: boolean;
     }): Promise<{
         data: GlobalContextDocument[];
     }>;
@@ -2218,6 +2221,8 @@ interface SequenceListParams {
     limit?: number;
     /** Filter by sequence status (e.g. "live", "draft", "paused"). */
     status?: string;
+    /** Filter by sequence kind ("cold_outbound" or "nurture"). Omit to list all kinds. */
+    sequence_kind?: SequenceKind;
 }
 interface SequenceDetail {
     id: string;
@@ -2231,6 +2236,10 @@ interface SequenceDetail {
     wait_for_new_contacts: boolean;
     paused_at: string | null;
     resumed_at: string | null;
+    /** Sequence kind. Immutable after creation. "cold_outbound" (default) or "nurture". */
+    sequence_kind?: string | null;
+    /** Pinned mailbox for nurture sequences; null for cold_outbound. Immutable. */
+    pinned_mailbox_id?: number | null;
     created_at: string | null;
     updated_at: string | null;
 }
@@ -2275,6 +2284,13 @@ interface SequenceChannelConfig {
     channel_type: string;
     channel_data?: Record<string, unknown>;
 }
+/**
+ * Sequence kind. A "nurture" is an ordinary sequence with `sequence_kind:
+ * "nurture"` — same step types as cold outreach, but pinned to a single mailbox
+ * with a higher daily email cap. There is no separate nurture client; create one
+ * via `sequences.create({ sequence_kind: "nurture", pinned_mailbox_id })`.
+ */
+type SequenceKind = "cold_outbound" | "nurture";
 interface SequenceCreateParams {
     name: string;
     user_email: string;
@@ -2286,6 +2302,18 @@ interface SequenceCreateParams {
     steps?: SequenceStepConfig[];
     channels?: SequenceChannelConfig[];
     campaign_id?: string;
+    /**
+     * Sequence kind. Defaults to "cold_outbound" server-side. Immutable after
+     * creation. "nurture" requires `pinned_mailbox_id` and is gated by the
+     * ENABLE_NURTURE feature flag.
+     */
+    sequence_kind?: SequenceKind;
+    /**
+     * Mailbox to pin for a nurture sequence. Required when
+     * `sequence_kind: "nurture"`; all email channels must use this mailbox.
+     * Ignored for cold_outbound sequences.
+     */
+    pinned_mailbox_id?: number;
 }
 interface SequenceCreateResult {
     id: string;
@@ -3369,6 +3397,7 @@ declare class G8 {
         globalContext(params?: {
             category?: string;
             limit?: number;
+            include_content?: boolean;
         }): Promise<{
             data: GlobalContextDocument[];
         }>;
@@ -3420,4 +3449,4 @@ declare class G8 {
 /** Singleton g8 client instance. */
 declare const g8: G8;
 
-export { type AddToSequenceConfig, type AnalyticsOverview, type Booking, type BookingRequest, type CalendarConfig, type CallAnalysis, type CallGradingResult, type Campaign, type CampaignCreateConfig, type CampaignStats, type ChatConfig, type Company, type CompanyColumn, type CompanyColumnCreateParams, type CompanyContact, type CompanyEnrichment, type CompanyListParams, type CompanyUpdateParams, type Contact, type ContactColumn, type ContactColumnCreateParams, type ContactCreateParams, type ContactDeal, type ContactList, type ContactListParams, type ContactUpdateParams, type CopilotConfig, type CreatedField, type Deal, type DealCreateParams, type DealListParams, type DealUpdateParams, type DialerAgentSummary, type DialerAgentsListParams, type DialerAgentsListResult, type DialerNumberInfo, type DialerNumbersListResult, type DialerReportFilters, type DialerReportMetric, type DialerSessionCreateParams, type DialerSessionCreateResult, type DialerSessionResumeResult, type DialerSessionStatus, type DialerSessionStatusUpdateResult, type DialerSessionSummary, type DialerSessionsListParams, type DialerSessionsListResult, type DialerStatsParams, type DialerStatsResult, type EmailVerification, type EnrichLookupResult, type EvidenceKey, type Field, type FieldCreateParams, type FieldDeleteParams, type G8Config, type G8PrivacyConfig, type GlobalContextDocument, type ICP, type IdentifyProperties, type InboxAssignResult, type InboxAssignee, type InboxChannel, type InboxContact, type InboxDraft, type InboxListParams, type InboxMessage, type InboxSendParams, type InboxSendResult, type InboxTag, type InboxTagResult, type InboxThread, type Integration, type IntelligenceData, type IntentCompany, type IntentContact, type IntentKeyword, type IntentPage, type IntentSignals, type IntentStats, type IntentVisitor, type LandingPage, type ListContact, type MeetingAnalysis, type MeetingAttendee, type MeetingDetail, type MeetingListParams, type MeetingSummary, type MeetingTranscriptLine, type MissedCallback, type MissedCallbacksResult, type NodeTypeSchema, type Note, type PaginationMeta$1 as PaginationMeta, type PersonEnrichment, type Persona, type Pipeline, type PipelineStage, type PipelineSuggestion, type QuotableProduct, type QuoteCreateParams, type QuoteDetail, type QuoteLineItem, type QuoteListParams, type QuoteSendParams, type QuoteSettings, type QuoteStatus, type QuoteSummary, type QuoteUpdateParams, type ResearchReport, type SearchFilter, type SearchResults, type Sequence, type SequenceActionResult, type SequenceAnalytics, type SequenceChannelConfig, type SequenceContactItem, type SequenceContactsParams, type SequenceCreateParams, type SequenceCreateResult, type SequenceDetail, type SequenceListItem, type SequenceListParams, type SequencePreview, type SequencePreviewChannel, type SequencePreviewStep, type SequenceStepConfig, type SequenceStepInputType, type SequenceStepType, type SequenceStepUpdateParams, type SequenceUpdateParams, type SetFieldValueParams, type Skill, type SkillCreateAPIParams, type SkillCreateLLMParams, type SkillInputField, type SkillListParams, type SkillTemplate, type SkillType, type SkillUpdateAPIParams, type SkillUpdateLLMParams, type StageCreateParams, type StagePipeline, type StagePipelineCreateParams, type StagePipelineStage, type StagePipelineUpdateParams, type StageUpdateParams, type Task, type TaskCreateParams, type TaskListParams, type TaskUpdateParams, type TimeSlot, type TrackProperties, type VisitorCompany, type VisitorScore, type VoicePagination, type VoiceSession, type WebhookEvent, type Workflow, type WorkflowConfig, type WorkflowConnection, type WorkflowCreateParams, type WorkflowExecution, type WorkflowListParams, type WorkflowNode, type WorkflowUpdateParams, g8 };
+export { type AddToSequenceConfig, type AnalyticsOverview, type Booking, type BookingRequest, type CalendarConfig, type CallAnalysis, type CallGradingResult, type Campaign, type CampaignCreateConfig, type CampaignStats, type ChatConfig, type Company, type CompanyColumn, type CompanyColumnCreateParams, type CompanyContact, type CompanyEnrichment, type CompanyListParams, type CompanyUpdateParams, type Contact, type ContactColumn, type ContactColumnCreateParams, type ContactCreateParams, type ContactDeal, type ContactList, type ContactListParams, type ContactUpdateParams, type CopilotConfig, type CreatedField, type Deal, type DealCreateParams, type DealListParams, type DealUpdateParams, type DialerAgentSummary, type DialerAgentsListParams, type DialerAgentsListResult, type DialerNumberInfo, type DialerNumbersListResult, type DialerReportFilters, type DialerReportMetric, type DialerSessionCreateParams, type DialerSessionCreateResult, type DialerSessionResumeResult, type DialerSessionStatus, type DialerSessionStatusUpdateResult, type DialerSessionSummary, type DialerSessionsListParams, type DialerSessionsListResult, type DialerStatsParams, type DialerStatsResult, type EmailVerification, type EnrichLookupResult, type EvidenceKey, type Field, type FieldCreateParams, type FieldDeleteParams, type G8Config, type G8PrivacyConfig, type GlobalContextDocument, type ICP, type IdentifyProperties, type InboxAssignResult, type InboxAssignee, type InboxChannel, type InboxContact, type InboxDraft, type InboxListParams, type InboxMessage, type InboxSendParams, type InboxSendResult, type InboxTag, type InboxTagResult, type InboxThread, type Integration, type IntelligenceData, type IntentCompany, type IntentContact, type IntentKeyword, type IntentPage, type IntentSignals, type IntentStats, type IntentVisitor, type LandingPage, type ListContact, type MeetingAnalysis, type MeetingAttendee, type MeetingDetail, type MeetingListParams, type MeetingSummary, type MeetingTranscriptLine, type MissedCallback, type MissedCallbacksResult, type NodeTypeSchema, type Note, type PaginationMeta$1 as PaginationMeta, type PersonEnrichment, type Persona, type Pipeline, type PipelineStage, type PipelineSuggestion, type QuotableProduct, type QuoteCreateParams, type QuoteDetail, type QuoteLineItem, type QuoteListParams, type QuoteSendParams, type QuoteSettings, type QuoteStatus, type QuoteSummary, type QuoteUpdateParams, type ResearchReport, type SearchFilter, type SearchResults, type Sequence, type SequenceActionResult, type SequenceAnalytics, type SequenceChannelConfig, type SequenceContactItem, type SequenceContactsParams, type SequenceCreateParams, type SequenceCreateResult, type SequenceDetail, type SequenceKind, type SequenceListItem, type SequenceListParams, type SequencePreview, type SequencePreviewChannel, type SequencePreviewStep, type SequenceStepConfig, type SequenceStepInputType, type SequenceStepType, type SequenceStepUpdateParams, type SequenceUpdateParams, type SetFieldValueParams, type Skill, type SkillCreateAPIParams, type SkillCreateLLMParams, type SkillInputField, type SkillListParams, type SkillTemplate, type SkillType, type SkillUpdateAPIParams, type SkillUpdateLLMParams, type StageCreateParams, type StagePipeline, type StagePipelineCreateParams, type StagePipelineStage, type StagePipelineUpdateParams, type StageUpdateParams, type Task, type TaskCreateParams, type TaskListParams, type TaskUpdateParams, type TimeSlot, type TrackProperties, type VisitorCompany, type VisitorScore, type VoicePagination, type VoiceSession, type WebhookEvent, type Workflow, type WorkflowConfig, type WorkflowConnection, type WorkflowCreateParams, type WorkflowExecution, type WorkflowListParams, type WorkflowNode, type WorkflowUpdateParams, g8 };

package/dist/index.d.ts

@@ -133,10 +133,13 @@ interface ResearchReport {
  *   GET /api/v1/research-reports
  */
 declare const createStudioClient: (apiKey: string, apiUrl?: string) => {
-    /** Org-level Studio documents (brand_brief, value_props, messaging_house, etc.). */
+    /** Org-level Studio documents (brand_brief, value_props, messaging_house, etc.).
+     * `include_content` defaults to true server-side, so each document includes
+     * its `content` body unless you explicitly pass `include_content: false`. */
     globalContext(params?: {
         category?: string;
         limit?: number;
+        include_content?: boolean;
     }): Promise<{
         data: GlobalContextDocument[];
     }>;
@@ -2218,6 +2221,8 @@ interface SequenceListParams {
     limit?: number;
     /** Filter by sequence status (e.g. "live", "draft", "paused"). */
     status?: string;
+    /** Filter by sequence kind ("cold_outbound" or "nurture"). Omit to list all kinds. */
+    sequence_kind?: SequenceKind;
 }
 interface SequenceDetail {
     id: string;
@@ -2231,6 +2236,10 @@ interface SequenceDetail {
     wait_for_new_contacts: boolean;
     paused_at: string | null;
     resumed_at: string | null;
+    /** Sequence kind. Immutable after creation. "cold_outbound" (default) or "nurture". */
+    sequence_kind?: string | null;
+    /** Pinned mailbox for nurture sequences; null for cold_outbound. Immutable. */
+    pinned_mailbox_id?: number | null;
     created_at: string | null;
     updated_at: string | null;
 }
@@ -2275,6 +2284,13 @@ interface SequenceChannelConfig {
     channel_type: string;
     channel_data?: Record<string, unknown>;
 }
+/**
+ * Sequence kind. A "nurture" is an ordinary sequence with `sequence_kind:
+ * "nurture"` — same step types as cold outreach, but pinned to a single mailbox
+ * with a higher daily email cap. There is no separate nurture client; create one
+ * via `sequences.create({ sequence_kind: "nurture", pinned_mailbox_id })`.
+ */
+type SequenceKind = "cold_outbound" | "nurture";
 interface SequenceCreateParams {
     name: string;
     user_email: string;
@@ -2286,6 +2302,18 @@ interface SequenceCreateParams {
     steps?: SequenceStepConfig[];
     channels?: SequenceChannelConfig[];
     campaign_id?: string;
+    /**
+     * Sequence kind. Defaults to "cold_outbound" server-side. Immutable after
+     * creation. "nurture" requires `pinned_mailbox_id` and is gated by the
+     * ENABLE_NURTURE feature flag.
+     */
+    sequence_kind?: SequenceKind;
+    /**
+     * Mailbox to pin for a nurture sequence. Required when
+     * `sequence_kind: "nurture"`; all email channels must use this mailbox.
+     * Ignored for cold_outbound sequences.
+     */
+    pinned_mailbox_id?: number;
 }
 interface SequenceCreateResult {
     id: string;
@@ -3369,6 +3397,7 @@ declare class G8 {
         globalContext(params?: {
             category?: string;
             limit?: number;
+            include_content?: boolean;
         }): Promise<{
             data: GlobalContextDocument[];
         }>;
@@ -3420,4 +3449,4 @@ declare class G8 {
 /** Singleton g8 client instance. */
 declare const g8: G8;
 
-export { type AddToSequenceConfig, type AnalyticsOverview, type Booking, type BookingRequest, type CalendarConfig, type CallAnalysis, type CallGradingResult, type Campaign, type CampaignCreateConfig, type CampaignStats, type ChatConfig, type Company, type CompanyColumn, type CompanyColumnCreateParams, type CompanyContact, type CompanyEnrichment, type CompanyListParams, type CompanyUpdateParams, type Contact, type ContactColumn, type ContactColumnCreateParams, type ContactCreateParams, type ContactDeal, type ContactList, type ContactListParams, type ContactUpdateParams, type CopilotConfig, type CreatedField, type Deal, type DealCreateParams, type DealListParams, type DealUpdateParams, type DialerAgentSummary, type DialerAgentsListParams, type DialerAgentsListResult, type DialerNumberInfo, type DialerNumbersListResult, type DialerReportFilters, type DialerReportMetric, type DialerSessionCreateParams, type DialerSessionCreateResult, type DialerSessionResumeResult, type DialerSessionStatus, type DialerSessionStatusUpdateResult, type DialerSessionSummary, type DialerSessionsListParams, type DialerSessionsListResult, type DialerStatsParams, type DialerStatsResult, type EmailVerification, type EnrichLookupResult, type EvidenceKey, type Field, type FieldCreateParams, type FieldDeleteParams, type G8Config, type G8PrivacyConfig, type GlobalContextDocument, type ICP, type IdentifyProperties, type InboxAssignResult, type InboxAssignee, type InboxChannel, type InboxContact, type InboxDraft, type InboxListParams, type InboxMessage, type InboxSendParams, type InboxSendResult, type InboxTag, type InboxTagResult, type InboxThread, type Integration, type IntelligenceData, type IntentCompany, type IntentContact, type IntentKeyword, type IntentPage, type IntentSignals, type IntentStats, type IntentVisitor, type LandingPage, type ListContact, type MeetingAnalysis, type MeetingAttendee, type MeetingDetail, type MeetingListParams, type MeetingSummary, type MeetingTranscriptLine, type MissedCallback, type MissedCallbacksResult, type NodeTypeSchema, type Note, type PaginationMeta$1 as PaginationMeta, type PersonEnrichment, type Persona, type Pipeline, type PipelineStage, type PipelineSuggestion, type QuotableProduct, type QuoteCreateParams, type QuoteDetail, type QuoteLineItem, type QuoteListParams, type QuoteSendParams, type QuoteSettings, type QuoteStatus, type QuoteSummary, type QuoteUpdateParams, type ResearchReport, type SearchFilter, type SearchResults, type Sequence, type SequenceActionResult, type SequenceAnalytics, type SequenceChannelConfig, type SequenceContactItem, type SequenceContactsParams, type SequenceCreateParams, type SequenceCreateResult, type SequenceDetail, type SequenceListItem, type SequenceListParams, type SequencePreview, type SequencePreviewChannel, type SequencePreviewStep, type SequenceStepConfig, type SequenceStepInputType, type SequenceStepType, type SequenceStepUpdateParams, type SequenceUpdateParams, type SetFieldValueParams, type Skill, type SkillCreateAPIParams, type SkillCreateLLMParams, type SkillInputField, type SkillListParams, type SkillTemplate, type SkillType, type SkillUpdateAPIParams, type SkillUpdateLLMParams, type StageCreateParams, type StagePipeline, type StagePipelineCreateParams, type StagePipelineStage, type StagePipelineUpdateParams, type StageUpdateParams, type Task, type TaskCreateParams, type TaskListParams, type TaskUpdateParams, type TimeSlot, type TrackProperties, type VisitorCompany, type VisitorScore, type VoicePagination, type VoiceSession, type WebhookEvent, type Workflow, type WorkflowConfig, type WorkflowConnection, type WorkflowCreateParams, type WorkflowExecution, type WorkflowListParams, type WorkflowNode, type WorkflowUpdateParams, g8 };
+export { type AddToSequenceConfig, type AnalyticsOverview, type Booking, type BookingRequest, type CalendarConfig, type CallAnalysis, type CallGradingResult, type Campaign, type CampaignCreateConfig, type CampaignStats, type ChatConfig, type Company, type CompanyColumn, type CompanyColumnCreateParams, type CompanyContact, type CompanyEnrichment, type CompanyListParams, type CompanyUpdateParams, type Contact, type ContactColumn, type ContactColumnCreateParams, type ContactCreateParams, type ContactDeal, type ContactList, type ContactListParams, type ContactUpdateParams, type CopilotConfig, type CreatedField, type Deal, type DealCreateParams, type DealListParams, type DealUpdateParams, type DialerAgentSummary, type DialerAgentsListParams, type DialerAgentsListResult, type DialerNumberInfo, type DialerNumbersListResult, type DialerReportFilters, type DialerReportMetric, type DialerSessionCreateParams, type DialerSessionCreateResult, type DialerSessionResumeResult, type DialerSessionStatus, type DialerSessionStatusUpdateResult, type DialerSessionSummary, type DialerSessionsListParams, type DialerSessionsListResult, type DialerStatsParams, type DialerStatsResult, type EmailVerification, type EnrichLookupResult, type EvidenceKey, type Field, type FieldCreateParams, type FieldDeleteParams, type G8Config, type G8PrivacyConfig, type GlobalContextDocument, type ICP, type IdentifyProperties, type InboxAssignResult, type InboxAssignee, type InboxChannel, type InboxContact, type InboxDraft, type InboxListParams, type InboxMessage, type InboxSendParams, type InboxSendResult, type InboxTag, type InboxTagResult, type InboxThread, type Integration, type IntelligenceData, type IntentCompany, type IntentContact, type IntentKeyword, type IntentPage, type IntentSignals, type IntentStats, type IntentVisitor, type LandingPage, type ListContact, type MeetingAnalysis, type MeetingAttendee, type MeetingDetail, type MeetingListParams, type MeetingSummary, type MeetingTranscriptLine, type MissedCallback, type MissedCallbacksResult, type NodeTypeSchema, type Note, type PaginationMeta$1 as PaginationMeta, type PersonEnrichment, type Persona, type Pipeline, type PipelineStage, type PipelineSuggestion, type QuotableProduct, type QuoteCreateParams, type QuoteDetail, type QuoteLineItem, type QuoteListParams, type QuoteSendParams, type QuoteSettings, type QuoteStatus, type QuoteSummary, type QuoteUpdateParams, type ResearchReport, type SearchFilter, type SearchResults, type Sequence, type SequenceActionResult, type SequenceAnalytics, type SequenceChannelConfig, type SequenceContactItem, type SequenceContactsParams, type SequenceCreateParams, type SequenceCreateResult, type SequenceDetail, type SequenceKind, type SequenceListItem, type SequenceListParams, type SequencePreview, type SequencePreviewChannel, type SequencePreviewStep, type SequenceStepConfig, type SequenceStepInputType, type SequenceStepType, type SequenceStepUpdateParams, type SequenceUpdateParams, type SetFieldValueParams, type Skill, type SkillCreateAPIParams, type SkillCreateLLMParams, type SkillInputField, type SkillListParams, type SkillTemplate, type SkillType, type SkillUpdateAPIParams, type SkillUpdateLLMParams, type StageCreateParams, type StagePipeline, type StagePipelineCreateParams, type StagePipelineStage, type StagePipelineUpdateParams, type StageUpdateParams, type Task, type TaskCreateParams, type TaskListParams, type TaskUpdateParams, type TimeSlot, type TrackProperties, type VisitorCompany, type VisitorScore, type VoicePagination, type VoiceSession, type WebhookEvent, type Workflow, type WorkflowConfig, type WorkflowConnection, type WorkflowCreateParams, type WorkflowExecution, type WorkflowListParams, type WorkflowNode, type WorkflowUpdateParams, g8 };

package/dist/index.js

@@ -1991,7 +1991,9 @@ var createStudioClient = (apiKey, apiUrl) => {
     return resp.json();
   };
   return {
-    /** Org-level Studio documents (brand_brief, value_props, messaging_house, etc.). */
+    /** Org-level Studio documents (brand_brief, value_props, messaging_house, etc.).
+     * `include_content` defaults to true server-side, so each document includes
+     * its `content` body unless you explicitly pass `include_content: false`. */
     async globalContext(params = {}) {
       return get("/global-context/documents", params);
     },