@burdenoff/sdk-libs 2026.627.4 → 2026.629.1

package/dist/modules/subscriberbot/index.d.ts

@@ -0,0 +1,497 @@
+import { J as Json, S as SdkModule } from '../../module-JDbvil5h.js';
+import 'graphql-request';
+
+type SubAgentKind = 'COMPLIANCE' | 'CONCIERGE' | 'COST' | 'DISCOVERY' | 'MIGRATION' | 'NEGOTIATION' | 'NEWSLETTER' | 'RENEWAL' | 'VENDOR';
+type SubAgentStatus = 'AUTONOMOUS' | 'DISABLED' | 'SUGGEST_ONLY';
+type SubAssetType = 'CERTIFICATE' | 'CONTRACT' | 'CREDENTIAL' | 'DOMAIN' | 'INVOICE' | 'LICENSE_KEY' | 'RECEIPT' | 'WARRANTY';
+type SubBillingInterval = 'DAILY' | 'FREE' | 'LIFETIME' | 'MONTHLY' | 'QUARTERLY' | 'USAGE_BASED' | 'WEEKLY' | 'YEARLY';
+type SubChannelStatus = 'DISABLED' | 'PENDING' | 'VERIFIED';
+type SubChannelType = 'DISCORD' | 'EMAIL' | 'PUSH' | 'SLACK' | 'SMS' | 'WEBHOOK' | 'WHATSAPP';
+type SubDiscoverySource = 'AI_AGENT' | 'EMAIL_SCAN' | 'IMPORT' | 'MANUAL' | 'PAYMENT_SCAN' | 'PROVIDER_CONNECT';
+type SubEntitlementType = 'CONTENT' | 'DISCOUNT' | 'FEATURE_ACCESS' | 'SEAT' | 'SUPPORT_TIER' | 'USAGE_QUOTA';
+type SubInvoiceStatus = 'CANCELLED' | 'DRAFT' | 'FAILED' | 'ISSUED' | 'OVERDUE' | 'PAID' | 'REFUNDED';
+type SubMessageCategory = 'BILLING' | 'MARKETING' | 'OTHER' | 'PRODUCT_UPDATE' | 'RENEWAL' | 'REQUIRED_ACTION' | 'SECURITY_ALERT';
+type SubPaymentInstrumentStatus = 'ACTIVE' | 'EXPIRED' | 'EXPIRING' | 'REMOVED';
+type SubPaymentInstrumentType = 'BANK_ACCOUNT' | 'CARD' | 'OTHER' | 'PAYPAL' | 'UPI' | 'WALLET';
+type SubPolicyAction = 'ALERT' | 'CANCEL' | 'CREATE_TASK' | 'DOWNGRADE' | 'PAUSE' | 'RENEW' | 'UPGRADE';
+type SubProviderCategory = 'AI_SERVICE' | 'ASSOCIATION' | 'COMMUNITY' | 'CONTRACT' | 'EDUCATION' | 'FINANCIAL' | 'INSURANCE' | 'LICENSE' | 'MEMBERSHIP' | 'NEWSLETTER' | 'NEWS_DIGEST' | 'OTHER' | 'SAAS' | 'STREAMING' | 'TELECOM' | 'UTILITY';
+type SubProviderStatus = 'CLAIMED' | 'DEPRECATED' | 'UNVERIFIED' | 'VERIFIED';
+type SubRelationshipKind = 'CONTRACT' | 'ENROLLMENT' | 'LICENSE' | 'MEMBERSHIP' | 'NEWSLETTER' | 'RECURRING_PAYMENT' | 'SUBSCRIPTION' | 'TRIAL';
+type SubRelationshipStatus = 'ACTIVE' | 'CANCELLED' | 'EXPIRED' | 'LAPSED' | 'PAST_DUE' | 'PAUSED' | 'TRIAL';
+type SubWorkflowStatus = 'ACTIVE' | 'ARCHIVED' | 'DRAFT' | 'PAUSED';
+interface PaginationInput {
+    cursor?: string;
+    limit?: number;
+    offset?: number;
+}
+interface SubPageInfo {
+    cursor?: string | null;
+    hasMore: boolean;
+}
+interface SubFileRef {
+    id: string;
+}
+interface SubProvider {
+    id: string;
+    name: string;
+    slug?: string | null;
+    description?: string | null;
+    category: SubProviderCategory;
+    status: SubProviderStatus;
+    industry?: string | null;
+    language?: string | null;
+    region?: string | null;
+    logoFileId?: string | null;
+    websiteUrl?: string | null;
+    tags: string[];
+    churnRiskScore?: number | null;
+    vendorHealthScore?: number | null;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+    plans?: SubPlan[];
+}
+interface SubPlan {
+    id: string;
+    name: string;
+    description?: string | null;
+    amount: number;
+    currency: string;
+    interval: SubBillingInterval;
+    features: string[];
+    isActive: boolean;
+    providerId: string;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+    provider?: SubProvider | null;
+}
+interface SubAsset {
+    id: string;
+    name: string;
+    type: SubAssetType;
+    relationshipId: string;
+    secretRef?: string | null;
+    expiresAt?: string | null;
+    file?: SubFileRef | null;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface SubEntitlement {
+    id: string;
+    name: string;
+    description?: string | null;
+    type: SubEntitlementType;
+    relationshipId: string;
+    quota?: number | null;
+    used: number;
+    unit?: string | null;
+    isActive: boolean;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface SubRenewalEvent {
+    id: string;
+    relationshipId: string;
+    eventType: string;
+    detail?: string | null;
+    amount?: number | null;
+    currency?: string | null;
+    occursAt: string;
+    notified: boolean;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface SubRelationship {
+    id: string;
+    label: string;
+    kind: SubRelationshipKind;
+    status: SubRelationshipStatus;
+    discoverySource: SubDiscoverySource;
+    ownerId: string;
+    providerId?: string | null;
+    planId?: string | null;
+    amount: number;
+    currency: string;
+    interval: SubBillingInterval;
+    autoRenew: boolean;
+    healthScore?: number | null;
+    notes?: string | null;
+    tags: string[];
+    startedAt?: string | null;
+    renewsAt?: string | null;
+    trialEndsAt?: string | null;
+    cancelledAt?: string | null;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+    provider?: SubProvider | null;
+    plan?: SubPlan | null;
+    assets?: SubAsset[];
+    entitlements?: SubEntitlement[];
+    renewalEvents?: SubRenewalEvent[];
+}
+interface SubInvoice {
+    id: string;
+    number?: string | null;
+    relationshipId: string;
+    status: SubInvoiceStatus;
+    subtotal: number;
+    taxAmount: number;
+    total: number;
+    currency: string;
+    lineItems?: Json | null;
+    paymentInstrumentId?: string | null;
+    issueDate?: string | null;
+    dueDate?: string | null;
+    paidAt?: string | null;
+    file?: SubFileRef | null;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface SubPaymentInstrument {
+    id: string;
+    label: string;
+    type: SubPaymentInstrumentType;
+    status: SubPaymentInstrumentStatus;
+    brand?: string | null;
+    last4?: string | null;
+    expiryMonth?: number | null;
+    expiryYear?: number | null;
+    isDefault: boolean;
+    ownerId: string;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface SubCommunicationChannel {
+    id: string;
+    address: string;
+    type: SubChannelType;
+    status: SubChannelStatus;
+    label?: string | null;
+    ingestEnabled: boolean;
+    ownerId: string;
+    verifiedAt?: string | null;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface SubInboxMessage {
+    id: string;
+    channelId: string;
+    relationshipId?: string | null;
+    category: SubMessageCategory;
+    categoryConfidence?: number | null;
+    subject?: string | null;
+    preview?: string | null;
+    externalId?: string | null;
+    actionRequired: boolean;
+    isRead: boolean;
+    receivedAt: string;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface SubPolicy {
+    id: string;
+    name: string;
+    description?: string | null;
+    agentId: string;
+    action: SubPolicyAction;
+    condition: Json;
+    isEnabled: boolean;
+    triggerCount: number;
+    lastTriggeredAt?: string | null;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface SubAiAgent {
+    id: string;
+    name: string;
+    description?: string | null;
+    kind: SubAgentKind;
+    status: SubAgentStatus;
+    ownerId: string;
+    config?: Json | null;
+    lastRunAt?: string | null;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+    policies?: SubPolicy[];
+}
+interface SubWorkflow {
+    id: string;
+    name: string;
+    description?: string | null;
+    status: SubWorkflowStatus;
+    triggerEvent: string;
+    steps: Json;
+    runCount: number;
+    lastRunAt?: string | null;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface SubProviderConnection {
+    items: SubProvider[];
+    pageInfo: SubPageInfo;
+}
+interface SubRelationshipConnection {
+    items: SubRelationship[];
+    pageInfo: SubPageInfo;
+}
+interface SubInvoiceConnection {
+    items: SubInvoice[];
+    pageInfo: SubPageInfo;
+}
+interface SubInboxMessageConnection {
+    items: SubInboxMessage[];
+    pageInfo: SubPageInfo;
+}
+interface SubCreateProviderInput {
+    name: string;
+    category?: SubProviderCategory;
+    status?: SubProviderStatus;
+    slug?: string;
+    description?: string;
+    industry?: string;
+    language?: string;
+    region?: string;
+    logoFileId?: string;
+    websiteUrl?: string;
+    tags?: string[];
+}
+interface SubUpdateProviderInput {
+    name?: string;
+    category?: SubProviderCategory;
+    status?: SubProviderStatus;
+    slug?: string;
+    description?: string;
+    industry?: string;
+    language?: string;
+    region?: string;
+    logoFileId?: string;
+    websiteUrl?: string;
+    tags?: string[];
+    churnRiskScore?: number;
+    vendorHealthScore?: number;
+}
+interface SubCreatePlanInput {
+    name: string;
+    providerId: string;
+    amount?: number;
+    currency?: string;
+    description?: string;
+    features?: string[];
+    interval?: SubBillingInterval;
+}
+interface SubCreateRelationshipInput {
+    label: string;
+    kind?: SubRelationshipKind;
+    status?: SubRelationshipStatus;
+    discoverySource?: SubDiscoverySource;
+    ownerId?: string;
+    providerId?: string;
+    planId?: string;
+    amount?: number;
+    currency?: string;
+    interval?: SubBillingInterval;
+    autoRenew?: boolean;
+    notes?: string;
+    tags?: string[];
+    startedAt?: string;
+    renewsAt?: string;
+    trialEndsAt?: string;
+}
+interface SubUpdateRelationshipInput {
+    label?: string;
+    kind?: SubRelationshipKind;
+    providerId?: string;
+    planId?: string;
+    amount?: number;
+    currency?: string;
+    interval?: SubBillingInterval;
+    autoRenew?: boolean;
+    healthScore?: number;
+    notes?: string;
+    tags?: string[];
+    startedAt?: string;
+    renewsAt?: string;
+    trialEndsAt?: string;
+}
+interface SubCreateAssetInput {
+    name: string;
+    relationshipId: string;
+    type?: SubAssetType;
+    fileId?: string;
+    secretRef?: string;
+    expiresAt?: string;
+}
+interface SubCreateEntitlementInput {
+    name: string;
+    relationshipId: string;
+    type?: SubEntitlementType;
+    description?: string;
+    quota?: number;
+    unit?: string;
+}
+interface SubCreateInvoiceInput {
+    relationshipId: string;
+    status?: SubInvoiceStatus;
+    number?: string;
+    currency?: string;
+    subtotal?: number;
+    taxAmount?: number;
+    total?: number;
+    lineItems?: Json;
+    paymentInstrumentId?: string;
+    fileId?: string;
+    issueDate?: string;
+    dueDate?: string;
+}
+interface SubCreatePaymentInstrumentInput {
+    label: string;
+    type?: SubPaymentInstrumentType;
+    brand?: string;
+    last4?: string;
+    expiryMonth?: number;
+    expiryYear?: number;
+    isDefault?: boolean;
+    ownerId?: string;
+    processorToken?: string;
+}
+interface SubCreateChannelInput {
+    address: string;
+    type?: SubChannelType;
+    label?: string;
+    ingestEnabled?: boolean;
+    ownerId?: string;
+}
+interface SubIngestMessageInput {
+    channelId: string;
+    receivedAt: string;
+    relationshipId?: string;
+    category?: SubMessageCategory;
+    categoryConfidence?: number;
+    subject?: string;
+    preview?: string;
+    externalId?: string;
+    actionRequired?: boolean;
+}
+interface SubCreateAgentInput {
+    name: string;
+    kind?: SubAgentKind;
+    status?: SubAgentStatus;
+    description?: string;
+    ownerId?: string;
+    config?: Json;
+}
+interface SubCreatePolicyInput {
+    name: string;
+    agentId: string;
+    action?: SubPolicyAction;
+    description?: string;
+    condition?: Json;
+    isEnabled?: boolean;
+}
+interface SubCreateWorkflowInput {
+    name: string;
+    triggerEvent: string;
+    description?: string;
+    steps?: Json;
+}
+
+interface SubscriberbotProvidersApi {
+    get(id: string): Promise<SubProvider | null>;
+    list(category?: SubProviderCategory, status?: SubProviderStatus, search?: string, pagination?: PaginationInput): Promise<SubProviderConnection>;
+    create(input: SubCreateProviderInput): Promise<SubProvider>;
+    update(id: string, input: SubUpdateProviderInput): Promise<SubProvider>;
+    archive(id: string): Promise<boolean>;
+}
+interface SubscriberbotPlansApi {
+    list(providerId?: string): Promise<SubPlan[]>;
+    create(input: SubCreatePlanInput): Promise<SubPlan>;
+}
+interface SubscriberbotRelationshipsApi {
+    get(id: string): Promise<SubRelationship | null>;
+    list(kind?: SubRelationshipKind, ownerId?: string, providerId?: string, status?: SubRelationshipStatus, pagination?: PaginationInput): Promise<SubRelationshipConnection>;
+    create(input: SubCreateRelationshipInput): Promise<SubRelationship>;
+    update(id: string, input: SubUpdateRelationshipInput): Promise<SubRelationship>;
+    cancel(id: string): Promise<SubRelationship>;
+    transition(id: string, status: SubRelationshipStatus): Promise<SubRelationship>;
+}
+interface SubscriberbotAssetsApi {
+    list(relationshipId: string): Promise<SubAsset[]>;
+    create(input: SubCreateAssetInput): Promise<SubAsset>;
+}
+interface SubscriberbotEntitlementsApi {
+    list(relationshipId: string): Promise<SubEntitlement[]>;
+    create(input: SubCreateEntitlementInput): Promise<SubEntitlement>;
+}
+interface SubscriberbotRenewalEventsApi {
+    list(relationshipId?: string, upcomingOnly?: boolean): Promise<SubRenewalEvent[]>;
+}
+interface SubscriberbotInvoicesApi {
+    list(relationshipId?: string, status?: SubInvoiceStatus, pagination?: PaginationInput): Promise<SubInvoiceConnection>;
+    create(input: SubCreateInvoiceInput): Promise<SubInvoice>;
+    markPaid(id: string): Promise<SubInvoice>;
+}
+interface SubscriberbotPaymentInstrumentsApi {
+    list(ownerId?: string): Promise<SubPaymentInstrument[]>;
+    create(input: SubCreatePaymentInstrumentInput): Promise<SubPaymentInstrument>;
+    remove(id: string): Promise<boolean>;
+}
+interface SubscriberbotChannelsApi {
+    list(ownerId?: string): Promise<SubCommunicationChannel[]>;
+    create(input: SubCreateChannelInput): Promise<SubCommunicationChannel>;
+    verify(id: string): Promise<SubCommunicationChannel>;
+}
+interface SubscriberbotInboxApi {
+    list(category?: SubMessageCategory, channelId?: string, relationshipId?: string, unreadOnly?: boolean, pagination?: PaginationInput): Promise<SubInboxMessageConnection>;
+    ingest(input: SubIngestMessageInput): Promise<SubInboxMessage>;
+    markRead(id: string): Promise<SubInboxMessage>;
+}
+interface SubscriberbotAgentsApi {
+    get(id: string): Promise<SubAiAgent | null>;
+    list(kind?: SubAgentKind, ownerId?: string, status?: SubAgentStatus): Promise<SubAiAgent[]>;
+    create(input: SubCreateAgentInput): Promise<SubAiAgent>;
+    setStatus(id: string, status: SubAgentStatus): Promise<SubAiAgent>;
+}
+interface SubscriberbotPoliciesApi {
+    list(agentId?: string): Promise<SubPolicy[]>;
+    create(input: SubCreatePolicyInput): Promise<SubPolicy>;
+}
+interface SubscriberbotWorkflowsApi {
+    list(status?: SubWorkflowStatus): Promise<SubWorkflow[]>;
+    create(input: SubCreateWorkflowInput): Promise<SubWorkflow>;
+    activate(id: string): Promise<SubWorkflow>;
+}
+interface SubscriberbotSystemApi {
+    health(): Promise<string>;
+}
+interface SubscriberbotApi {
+    providers: SubscriberbotProvidersApi;
+    plans: SubscriberbotPlansApi;
+    relationships: SubscriberbotRelationshipsApi;
+    assets: SubscriberbotAssetsApi;
+    entitlements: SubscriberbotEntitlementsApi;
+    renewalEvents: SubscriberbotRenewalEventsApi;
+    invoices: SubscriberbotInvoicesApi;
+    paymentInstruments: SubscriberbotPaymentInstrumentsApi;
+    channels: SubscriberbotChannelsApi;
+    inbox: SubscriberbotInboxApi;
+    agents: SubscriberbotAgentsApi;
+    policies: SubscriberbotPoliciesApi;
+    workflows: SubscriberbotWorkflowsApi;
+    system: SubscriberbotSystemApi;
+}
+
+declare const subscriberbotModule: SdkModule<SubscriberbotApi>;
+
+export { type PaginationInput, type SubAgentKind, type SubAgentStatus, type SubAiAgent, type SubAsset, type SubAssetType, type SubBillingInterval, type SubChannelStatus, type SubChannelType, type SubCommunicationChannel, type SubCreateAgentInput, type SubCreateAssetInput, type SubCreateChannelInput, type SubCreateEntitlementInput, type SubCreateInvoiceInput, type SubCreatePaymentInstrumentInput, type SubCreatePlanInput, type SubCreatePolicyInput, type SubCreateProviderInput, type SubCreateRelationshipInput, type SubCreateWorkflowInput, type SubDiscoverySource, type SubEntitlement, type SubEntitlementType, type SubFileRef, type SubInboxMessage, type SubInboxMessageConnection, type SubIngestMessageInput, type SubInvoice, type SubInvoiceConnection, type SubInvoiceStatus, type SubMessageCategory, type SubPageInfo, type SubPaymentInstrument, type SubPaymentInstrumentStatus, type SubPaymentInstrumentType, type SubPlan, type SubPolicy, type SubPolicyAction, type SubProvider, type SubProviderCategory, type SubProviderConnection, type SubProviderStatus, type SubRelationship, type SubRelationshipConnection, type SubRelationshipKind, type SubRelationshipStatus, type SubRenewalEvent, type SubUpdateProviderInput, type SubUpdateRelationshipInput, type SubWorkflow, type SubWorkflowStatus, type SubscriberbotAgentsApi, type SubscriberbotApi, type SubscriberbotAssetsApi, type SubscriberbotChannelsApi, type SubscriberbotEntitlementsApi, type SubscriberbotInboxApi, type SubscriberbotInvoicesApi, type SubscriberbotPaymentInstrumentsApi, type SubscriberbotPlansApi, type SubscriberbotPoliciesApi, type SubscriberbotProvidersApi, type SubscriberbotRelationshipsApi, type SubscriberbotRenewalEventsApi, type SubscriberbotSystemApi, type SubscriberbotWorkflowsApi, subscriberbotModule as default };