@geoly-ai/social-hub-sdk 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,681 @@
+export type SocialHubClientOptions = {
+    baseUrl: string;
+    apiKey: string;
+};
+export type HealthCheckJson = {
+    ok?: boolean;
+    db?: string;
+    redis?: string;
+};
+/** GET /health without API key. */
+export declare function getSocialHubHealth(baseUrl: string): Promise<HealthCheckJson>;
+/** GET /health/live without API key. */
+export declare function getSocialHubHealthLive(baseUrl: string): Promise<{
+    ok: boolean;
+}>;
+/** POST /v1/auth/device/code — no API key required. */
+export declare function createDeviceCode(baseUrl: string, body: {
+    clientName?: string;
+    deviceName?: string;
+    teamId?: string;
+    durationKind?: "short" | "long" | "custom";
+    expiresAt?: string;
+}): Promise<DeviceCodeResponse>;
+/** POST /v1/auth/device/token — poll for CLI access token. */
+export declare function pollDeviceToken(baseUrl: string, deviceCode: string): Promise<PollDeviceTokenResponse>;
+/** Query params for GET /calendar-entries */
+export type ListCalendarEntriesParams = {
+    campaignId?: string;
+    publishingPlanId?: string;
+    socialAccountId?: string;
+    status?: string;
+    from?: string;
+    to?: string;
+    limit?: number;
+};
+/** Body for PATCH /calendar-entries/:id */
+export type UpdateCalendarEntryBody = {
+    plannedAt?: string;
+    status?: string;
+    permalink?: string;
+    failureReason?: string;
+};
+export type ListRedditPostSnapshotsParams = {
+    limit?: number;
+    campaignId?: string;
+    calendarEntryId?: string;
+    socialAccountId?: string;
+};
+export type RedditPostSnapshotStatsParams = {
+    campaignId?: string;
+    calendarEntryId?: string;
+    opsStatus?: string;
+    postType?: string;
+    range?: number;
+    compare?: "wow" | "mom" | "both";
+};
+export type DeviceCodeResponse = {
+    device_code: string;
+    user_code: string;
+    verification_uri: string;
+    verification_uri_complete: string;
+    expires_in: number;
+    interval: number;
+};
+export type PollDeviceTokenResponse = {
+    error: "authorization_pending";
+} | {
+    error: "slow_down";
+} | {
+    error: "expired_token";
+} | {
+    error: "access_denied";
+} | {
+    access_token: string;
+    token_type: "Bearer";
+    expires_at: string;
+    team_id: string;
+    team_ids?: string[];
+    duration_kind: "short" | "long" | "custom";
+    downgraded?: boolean;
+};
+export type AuthContextResponse = {
+    kind: "api_key" | "session" | "cli_token";
+    teamId: string;
+    role: string;
+    visibleTeamIds: string[];
+    visibleBrandIds: string[];
+    visibleCampaignIds: string[] | null;
+    visibleAccountIds: string[];
+    userId?: string;
+    email?: string;
+    name?: string;
+};
+export type UpdateCampaignBody = {
+    name?: string;
+    startsAt?: string | null;
+    endsAt?: string | null;
+};
+export type UpdateContentDraftBody = {
+    title?: string;
+    body?: string;
+    status?: string;
+};
+export type UpdateNotificationChannelBody = {
+    provider?: string;
+    externalId?: string;
+    minRole?: string;
+    campaignId?: string | null;
+};
+export type ListSubredditWatchlistsParams = {
+    limit?: number;
+    offset?: number;
+    campaignId?: string;
+};
+export type ListHotPostsParams = {
+    limit?: number;
+    offset?: number;
+    subreddit?: string;
+    sortBy?: "score" | "comments" | "capturedAt" | "upvoteRatio";
+};
+export type ListKolIntentsParams = {
+    limit?: number;
+    offset?: number;
+    campaignId?: string;
+    status?: "interested" | "contacting" | "connected" | "not_interested";
+    sortBy?: "createdAt" | "status" | "rating" | "karma" | "activity" | "lastActive";
+    sortOrder?: "asc" | "desc";
+};
+export type ListEventsParams = {
+    limit?: number;
+    type?: string;
+    actor?: string;
+    result?: string;
+    socialAccountId?: string;
+    createdFrom?: string;
+    createdTo?: string;
+};
+export type ListNotificationChannelsParams = {
+    campaignId?: string;
+};
+export type ListApiKeysParams = {
+    limit?: number;
+};
+export type AccountGraphDrilldownParams = {
+    socialAccountId: string;
+    limit?: number;
+};
+export type ListScheduledJobsParams = {
+    limit?: number;
+    status?: string;
+    socialAccountId?: string;
+    from?: string;
+    to?: string;
+};
+export type ListAccountsParams = {
+    limit?: number;
+    status?: string;
+    platform?: string;
+    campaignId?: string;
+};
+export type ListAuditLogsParams = {
+    limit?: number;
+    type?: string;
+    actor?: "user" | "agent" | "cron";
+    result?: "succeeded" | "failed" | "skipped";
+    socialAccountId?: string;
+    createdFrom?: string;
+    createdTo?: string;
+};
+export type ListAccountGraphParams = {
+    limit?: number;
+    cursor?: string;
+    socialAccountId?: string;
+    edgeType?: string;
+    minRisk?: "high" | "medium" | "low";
+};
+export type ListCampaignsParams = {
+    brandId?: string;
+};
+export type ListPublishingPlansParams = {
+    campaignId?: string;
+};
+export type ListSubredditSanctionsParams = {
+    limit?: number;
+    socialAccountId?: string;
+    subreddit?: string;
+};
+export type ListReportsParams = {
+    limit?: number;
+    reportType?: "reddit-post-snapshot" | "account-status-snapshot" | "campaign-digest";
+};
+export declare class SocialHubClient {
+    private readonly opts;
+    constructor(opts: SocialHubClientOptions);
+    private teamBase;
+    /** GET /health — no API key required. */
+    getHealth(): Promise<HealthCheckJson>;
+    private fetchJson;
+    appendEvent(teamId: string, body: {
+        type: string;
+        socialAccountId?: string;
+        payload?: Record<string, unknown>;
+    }): Promise<{
+        id: string;
+    }>;
+    listEvents(teamId: string, limit?: number): Promise<{
+        items: {
+            id: string;
+            teamId: string;
+            type: string;
+            socialAccountId: string | null;
+            payload: Record<string, unknown> | null;
+            createdAt: string;
+        }[];
+    }>;
+    getDashboardSummary(teamId: string, params?: {
+        interactionTrendDays?: 7 | 14 | 30;
+        campaignId?: string;
+        brandId?: string;
+        from?: string;
+        to?: string;
+    }): Promise<{
+        metrics?: Record<string, number | undefined>;
+    }>;
+    listCalendarEntries(teamId: string, params?: ListCalendarEntriesParams): Promise<{
+        items: unknown[];
+    }>;
+    updateCalendarEntry(teamId: string, entryId: string, body: UpdateCalendarEntryBody): Promise<{
+        ok: boolean;
+        warning?: string;
+    }>;
+    listRedditPostSnapshots(teamId: string, params?: ListRedditPostSnapshotsParams): Promise<{
+        items: unknown[];
+    }>;
+    getRedditPostSnapshotStats(teamId: string, params?: RedditPostSnapshotStatsParams): Promise<unknown>;
+    getRedditPostRefreshStatus(teamId: string): Promise<unknown>;
+    refreshAllRedditPostSnapshots(teamId: string): Promise<{
+        queued: number;
+        batchId?: string;
+        warning?: string;
+    }>;
+    getRedditRefreshAllProgress(teamId: string, batchId: string): Promise<unknown>;
+    refreshRedditPostSnapshot(teamId: string, snapshotId: string): Promise<{
+        queued: number;
+        warning?: string;
+    }>;
+    updateRedditPostSnapshot(teamId: string, snapshotId: string, body: Record<string, unknown>): Promise<{
+        ok: boolean;
+    }>;
+    deleteRedditPostSnapshot(teamId: string, snapshotId: string): Promise<{
+        ok: boolean;
+    }>;
+    importRedditPostSnapshotsFromFeishu(teamId: string, body?: {
+        baseToken?: string;
+        tableId?: string;
+    }): Promise<unknown>;
+    listScheduledJobs(teamId: string, params?: ListScheduledJobsParams): Promise<{
+        items: unknown[];
+    }>;
+    getScheduledJobsAutomationSummary(teamId: string, hours?: number): Promise<{
+        summary: Record<string, number>;
+    }>;
+    createScheduledJob(teamId: string, body: Record<string, unknown>): Promise<unknown>;
+    createScheduledJobsBatch(teamId: string, body: {
+        jobs: Record<string, unknown>[];
+    }): Promise<unknown>;
+    retryScheduledJob(teamId: string, jobId: string): Promise<unknown>;
+    cancelScheduledJob(teamId: string, jobId: string): Promise<unknown>;
+    listContentDrafts(teamId: string, limit?: number): Promise<{
+        items: unknown[];
+    }>;
+    createContentDraft(teamId: string, body: {
+        campaignId: string;
+        title: string;
+        body: string;
+    }): Promise<{
+        id: string;
+    }>;
+    listReports(teamId: string, options?: ListReportsParams | number): Promise<{
+        items: unknown[];
+    }>;
+    ingestReport(teamId: string, body: {
+        reportType: "reddit-post-snapshot" | "account-status-snapshot" | "campaign-digest";
+        source: string;
+        traceId?: string;
+    }): Promise<unknown>;
+    listAccounts(teamId: string, params?: ListAccountsParams): Promise<{
+        items: unknown[];
+    }>;
+    createAccount(teamId: string, body: Record<string, unknown>): Promise<{
+        id: string;
+    }>;
+    listBrands(teamId: string): Promise<{
+        items: unknown[];
+    }>;
+    createBrand(teamId: string, body: {
+        name: string;
+        slug?: string;
+    }): Promise<{
+        id: string;
+    }>;
+    updateBrand(teamId: string, brandId: string, body: Record<string, unknown>): Promise<unknown>;
+    listCampaigns(teamId: string, params?: ListCampaignsParams): Promise<{
+        items: unknown[];
+    }>;
+    createCampaign(teamId: string, body: {
+        brandId: string;
+        name: string;
+        startsAt?: string;
+        endsAt?: string;
+    }): Promise<{
+        id: string;
+    }>;
+    listPublishingPlans(teamId: string, params?: ListPublishingPlansParams): Promise<{
+        items: unknown[];
+    }>;
+    createPublishingPlan(teamId: string, body: Record<string, unknown>): Promise<unknown>;
+    listAuditLogs(teamId: string, params?: ListAuditLogsParams): Promise<{
+        items: unknown[];
+    }>;
+    getPermissionsMatrix(teamId: string): Promise<unknown>;
+    listAccountGraphEdges(teamId: string, params?: ListAccountGraphParams): Promise<{
+        items: unknown[];
+        nextCursor?: string;
+    }>;
+    createRedditPostSnapshot(teamId: string, body: Record<string, unknown>): Promise<{
+        id: string;
+    }>;
+    appendEventsBatch(teamId: string, body: {
+        events: Record<string, unknown>[];
+    }): Promise<unknown>;
+    triggerOpenClawIngest(teamId: string, body: {
+        mode: "dry-run" | "apply";
+        sourceRoot?: string;
+        sourcePaths?: Record<string, string>;
+    }): Promise<unknown>;
+    listSubredditSanctions(teamId: string, params?: ListSubredditSanctionsParams): Promise<{
+        items: unknown[];
+    }>;
+    createSubredditSanction(teamId: string, body: {
+        socialAccountId: string;
+        subreddit: string;
+        status: string;
+        reason?: string;
+        expiresAt?: string;
+    }): Promise<{
+        id: string;
+    }>;
+    listAccountRiskProfiles(teamId: string, limit?: number): Promise<{
+        items: unknown[];
+    }>;
+    getAccountRiskProfile(teamId: string, socialAccountId: string): Promise<unknown>;
+    upsertAccountRiskProfile(teamId: string, socialAccountId: string, body: Record<string, unknown>): Promise<unknown>;
+    getAccount(teamId: string, accountId: string): Promise<unknown>;
+    updateAccount(teamId: string, accountId: string, body: {
+        handle?: string | null;
+        profileUrl?: string | null;
+        status?: string;
+        credentialsRef?: string | null;
+        externalId?: string | null;
+        karma?: number | null;
+        accountAgeDays?: number | null;
+        workflowStage?: string | null;
+        metricsSource?: string | null;
+        metricsUpdatedAt?: string | null;
+    }): Promise<{
+        ok: boolean;
+    }>;
+    getCampaign(teamId: string, campaignId: string): Promise<unknown>;
+    updateCampaign(teamId: string, campaignId: string, body: UpdateCampaignBody): Promise<unknown>;
+    getContentDraft(teamId: string, draftId: string): Promise<unknown>;
+    updateContentDraft(teamId: string, draftId: string, body: UpdateContentDraftBody): Promise<unknown>;
+    deleteContentDraft(teamId: string, draftId: string): Promise<void>;
+    cancelPublishingPlan(teamId: string, planId: string): Promise<void>;
+    listAgentTeams(): Promise<{
+        items: unknown[];
+    }>;
+    listWorkspaceDocuments(teamId: string, params?: {
+        kind?: string;
+        limit?: number;
+    }): Promise<{
+        items: unknown[];
+    }>;
+    createTeam(body: {
+        slug: string;
+        name: string;
+    }): Promise<{
+        id: string;
+    }>;
+    updateTeam(teamId: string, body: {
+        slug?: string;
+        name?: string;
+    }): Promise<{
+        ok: boolean;
+    }>;
+    addTeamMember(teamId: string, body: {
+        userId: string;
+        role: string;
+    }): Promise<{
+        id: string;
+    }>;
+    listSubredditWatchlists(teamId: string, params?: ListSubredditWatchlistsParams): Promise<{
+        items: unknown[];
+        total: number;
+        limit: number;
+        offset: number;
+    }>;
+    createSubredditWatchlist(teamId: string, body: Record<string, unknown>): Promise<{
+        id: string;
+    }>;
+    updateSubredditWatchlist(teamId: string, watchlistId: string, body: Record<string, unknown>): Promise<{
+        ok: boolean;
+    }>;
+    deleteSubredditWatchlist(teamId: string, watchlistId: string): Promise<void>;
+    listHotPosts(teamId: string, params?: ListHotPostsParams): Promise<{
+        items: unknown[];
+        total: number;
+        limit: number;
+        offset: number;
+    }>;
+    createHotPost(teamId: string, body: Record<string, unknown>): Promise<{
+        id: string;
+    }>;
+    exportHotPostsCsv(teamId: string, params?: ListHotPostsParams): Promise<string>;
+    listKolIntents(teamId: string, params?: ListKolIntentsParams): Promise<{
+        items: unknown[];
+        total: number;
+        limit: number;
+        offset: number;
+    }>;
+    createKolIntent(teamId: string, body: Record<string, unknown>): Promise<{
+        id: string;
+    }>;
+    dispatchTaskFromHotPost(teamId: string, body: {
+        hotPostId: string;
+        socialAccountId: string;
+        action: string;
+        runAt?: string;
+    }): Promise<unknown>;
+    listUsers(teamId: string): Promise<{
+        items: unknown[];
+    }>;
+    createUser(teamId: string, body: Record<string, unknown>): Promise<{
+        id: string;
+    }>;
+    listBrandMembers(teamId: string, params?: {
+        userId?: string;
+    }): Promise<{
+        items: unknown[];
+    }>;
+    createBrandMember(teamId: string, body: {
+        brandId: string;
+        userId: string;
+        role?: string;
+    }): Promise<{
+        id: string;
+    }>;
+    listNotificationChannels(teamId: string, params?: ListNotificationChannelsParams): Promise<{
+        items: unknown[];
+    }>;
+    createNotificationChannel(teamId: string, body: {
+        provider: string;
+        externalId: string;
+        minRole?: string;
+        campaignId?: string;
+    }): Promise<{
+        id: string;
+    }>;
+    updateNotificationChannel(teamId: string, channelId: string, body: UpdateNotificationChannelBody): Promise<{
+        ok: boolean;
+    }>;
+    deleteNotificationChannel(teamId: string, channelId: string): Promise<void>;
+    testNotificationChannel(teamId: string, channelId: string): Promise<{
+        ok: boolean;
+        warning?: string;
+        jobId?: string;
+    }>;
+    listApiKeys(teamId: string, params?: ListApiKeysParams): Promise<{
+        items: unknown[];
+    }>;
+    createApiKey(teamId: string, body: Record<string, unknown>): Promise<{
+        id: string;
+        key: string;
+    }>;
+    deleteApiKey(teamId: string, apiKeyId: string): Promise<void>;
+    rotateApiKey(teamId: string, apiKeyId: string): Promise<{
+        id: string;
+        key: string;
+    }>;
+    batchRevokeApiKeys(teamId: string, ids: string[]): Promise<unknown>;
+    batchRotateApiKeys(teamId: string, ids: string[]): Promise<unknown>;
+    listEventsFiltered(teamId: string, params?: ListEventsParams): Promise<{
+        items: unknown[];
+    }>;
+    exportEventsCsv(teamId: string, params?: ListEventsParams): Promise<string>;
+    createReport(teamId: string, body: Record<string, unknown>): Promise<{
+        id: string;
+    }>;
+    updateJobAgentStatus(teamId: string, jobId: string, body: {
+        status: "running" | "succeeded" | "failed";
+        lastError?: string;
+        payload?: Record<string, unknown>;
+    }): Promise<unknown>;
+    updatePermissionsMatrix(teamId: string, body: Record<string, unknown>): Promise<unknown>;
+    getAccountGraphDrilldown(teamId: string, params: AccountGraphDrilldownParams): Promise<unknown>;
+    sessionLogin(body: {
+        email: string;
+        password: string;
+    }): Promise<unknown>;
+    sessionLogout(): Promise<unknown>;
+    sessionMe(): Promise<unknown>;
+    sessionActiveTeam(body: {
+        teamId: string;
+    }): Promise<unknown>;
+    sessionSetPassword(body: {
+        email: string;
+        teamId?: string;
+        password: string;
+    }): Promise<unknown>;
+    sessionUpdateProfile(body: {
+        name: string;
+    }): Promise<unknown>;
+    listTeamBrowserEnvironments(teamId: string): Promise<unknown>;
+    listAccountBrowserEnvironments(teamId: string, accountId: string): Promise<unknown>;
+    createBrowserEnvironment(teamId: string, accountId: string, body: {
+        ipAddress?: string;
+        userAgent?: string;
+        timezone?: string;
+        language?: string;
+        platform?: string;
+        notes?: string;
+    }): Promise<unknown>;
+    listAccountPersonas(teamId: string, accountId: string): Promise<unknown>;
+    createAccountPersona(teamId: string, accountId: string, body: {
+        markdown: string;
+    }): Promise<unknown>;
+    listCampaignAccounts(teamId: string, campaignId: string): Promise<unknown>;
+    assignCampaignAccount(teamId: string, campaignId: string, body: {
+        socialAccountId: string;
+        visibility?: string;
+    }): Promise<unknown>;
+    removeCampaignAccount(teamId: string, campaignId: string, socialAccountId: string): Promise<unknown>;
+    deleteBrandMember(teamId: string, memberId: string): Promise<unknown>;
+    deleteAccount(teamId: string, accountId: string): Promise<{
+        ok: boolean;
+    }>;
+    listAccountBrandBindings(teamId: string, accountId: string): Promise<{
+        items: unknown[];
+    }>;
+    addAccountBrandBinding(teamId: string, accountId: string, body: {
+        brandId: string;
+    }): Promise<unknown>;
+    removeAccountBrandBinding(teamId: string, accountId: string, brandId: string): Promise<{
+        ok: boolean;
+    }>;
+    listAccountStatusSnapshots(teamId: string, accountId: string, limit?: number): Promise<{
+        items: unknown[];
+    }>;
+    getAuthContext(): Promise<AuthContextResponse>;
+    revokeCurrentCliToken(): Promise<{
+        ok: boolean;
+    }>;
+    opsClaimNext(teamId: string, body: {
+        agentId: string;
+        socialAccountId?: string;
+        leaseSeconds?: number;
+    }): Promise<{
+        job: unknown | null;
+    }>;
+    opsClaim(teamId: string, body: {
+        agentId: string;
+        jobId: string;
+        leaseSeconds?: number;
+    }): Promise<{
+        job: unknown;
+    }>;
+    opsHeartbeat(teamId: string, body: {
+        agentId: string;
+        jobId: string;
+        leaseSeconds?: number;
+        payload?: Record<string, unknown>;
+    }): Promise<{
+        ok: boolean;
+    }>;
+    opsComplete(teamId: string, body: {
+        agentId: string;
+        jobId: string;
+        permalink?: string;
+        calendarEntryId?: string;
+        redditPostSnapshotId?: string;
+        payload?: Record<string, unknown>;
+    }): Promise<{
+        ok: boolean;
+        jobId: string;
+        status: string;
+        trace: Record<string, unknown>;
+        updated: Record<string, unknown>;
+    }>;
+    opsFail(teamId: string, body: {
+        agentId: string;
+        jobId: string;
+        reason: string;
+        message?: string;
+        payload?: Record<string, unknown>;
+    }): Promise<{
+        ok: boolean;
+        jobId: string;
+        status: string;
+    }>;
+    opsSkip(teamId: string, body: {
+        agentId: string;
+        jobId: string;
+        reason: string;
+        message?: string;
+        payload?: Record<string, unknown>;
+    }): Promise<{
+        ok: boolean;
+        jobId: string;
+        status: string;
+    }>;
+    getAccountAgentContext(teamId: string, accountRef: string, params?: {
+        expand?: string;
+    }): Promise<Record<string, unknown>>;
+    getJobAgentContext(teamId: string, jobId: string): Promise<Record<string, unknown>>;
+    listAccountPools(teamId: string, accountRef: string, params?: {
+        status?: string;
+        industry?: string;
+        limit?: number;
+    }): Promise<{
+        items: unknown[];
+    }>;
+    listSubredditCandidates(teamId: string, accountRef: string, params?: {
+        industry?: string;
+        action?: string;
+        limit?: number;
+    }): Promise<{
+        items: unknown[];
+    }>;
+    listSettings(): Promise<{
+        items: Array<{
+            key: string;
+            value: string;
+        }>;
+    }>;
+    getSetting(key: string): Promise<{
+        key: string;
+        value: string;
+    }>;
+    upsertSetting(key: string, body: {
+        value: string;
+        description?: string;
+    }): Promise<{
+        key: string;
+        value: string;
+    }>;
+    listTeamInvites(teamId: string): Promise<{
+        items: unknown[];
+    }>;
+    createTeamInvite(teamId: string, body: {
+        email: string;
+        role: string;
+        brandId?: string;
+    }): Promise<unknown>;
+    revokeTeamInvite(teamId: string, inviteId: string): Promise<{
+        ok: boolean;
+    }>;
+    listSystemMembers(): Promise<{
+        items: unknown[];
+    }>;
+    updateSystemMemberRole(userId: string, body: {
+        role: string;
+    }): Promise<{
+        updated: boolean;
+    }>;
+    listIndustryPools(teamId: string, params?: {
+        limit?: number;
+    }): Promise<{
+        items: unknown[];
+    }>;
+}
+//# sourceMappingURL=index.d.ts.map