@armor/zuora-mcp 0.0.0-development

package/dist/types.d.ts

@@ -0,0 +1,758 @@
+/**
+ * Type definitions for Zuora MCP Server
+ */
+export interface ToolResult {
+    success: boolean;
+    message: string;
+    data?: unknown;
+}
+export interface TokenResponse {
+    access_token: string;
+    token_type: string;
+    expires_in: number;
+    scope: string;
+    jti: string;
+}
+export interface ZuoraApiError {
+    success?: boolean;
+    processId?: string;
+    reasons?: Array<{
+        code: number;
+        message: string;
+    }>;
+    message?: string;
+}
+export interface ZuoraContact {
+    id: string;
+    firstName: string;
+    lastName: string;
+    workEmail: string;
+    address1?: string;
+    city?: string;
+    state?: string;
+    postalCode?: string;
+    country?: string;
+}
+export interface ZuoraAccount {
+    id: string;
+    accountNumber: string;
+    name: string;
+    status: string;
+    currency: string;
+    balance: number;
+    creditBalance: number;
+    totalInvoiceBalance: number;
+    billToContact?: ZuoraContact;
+    soldToContact?: ZuoraContact;
+    paymentTerm: string;
+    billCycleDay: number;
+    autoPay: boolean;
+    createdDate: string;
+    updatedDate: string;
+}
+export interface ZuoraAccountSummary {
+    basicInfo: {
+        id: string;
+        accountNumber: string;
+        name: string;
+        status: string;
+        balance: number;
+        currency: string;
+    };
+    subscriptions: Array<{
+        id: string;
+        subscriptionNumber: string;
+        status: string;
+        termType: string;
+        termStartDate: string;
+        termEndDate: string;
+        ratePlans: Array<{
+            productName: string;
+            ratePlanName: string;
+        }>;
+    }>;
+    invoices: Array<{
+        id: string;
+        invoiceNumber: string;
+        invoiceDate: string;
+        dueDate: string;
+        amount: number;
+        balance: number;
+        status: string;
+    }>;
+    payments: Array<{
+        id: string;
+        paymentNumber: string;
+        effectiveDate: string;
+        amount: number;
+        status: string;
+    }>;
+    usage: Array<{
+        unitOfMeasure: string;
+        quantity: number;
+        startDate: string;
+    }>;
+}
+export interface ZuoraInvoiceItem {
+    id: string;
+    subscriptionId: string;
+    subscriptionName: string;
+    serviceStartDate: string;
+    serviceEndDate: string;
+    chargeAmount: number;
+    chargeName: string;
+    chargeDescription?: string;
+    quantity: number;
+    unitOfMeasure: string;
+    taxAmount: number;
+}
+export interface ZuoraInvoice {
+    id: string;
+    invoiceNumber: string;
+    accountId: string;
+    accountNumber: string;
+    accountName: string;
+    invoiceDate: string;
+    dueDate: string;
+    amount: number;
+    balance: number;
+    status: string;
+    body?: string;
+    invoiceItems?: ZuoraInvoiceItem[];
+    createdDate: string;
+    updatedDate: string;
+}
+export interface ZuoraRatePlanCharge {
+    id: string;
+    chargeNumber: string;
+    name: string;
+    type: string;
+    model: string;
+    currency: string;
+    price: number;
+    quantity: number;
+    mrr: number;
+    tcv: number;
+    billingPeriod: string;
+    effectiveStartDate: string;
+    effectiveEndDate: string;
+}
+export interface ZuoraRatePlan {
+    id: string;
+    productId: string;
+    productName: string;
+    productRatePlanId: string;
+    ratePlanName: string;
+    ratePlanCharges: ZuoraRatePlanCharge[];
+}
+export interface ZuoraSubscription {
+    id: string;
+    subscriptionNumber: string;
+    accountId: string;
+    accountNumber: string;
+    accountName: string;
+    status: string;
+    termType: string;
+    termStartDate: string;
+    termEndDate: string;
+    contractEffectiveDate: string;
+    serviceActivationDate?: string;
+    contractedMrr: number;
+    totalContractedValue: number;
+    autoRenew: boolean;
+    renewalTerm: number;
+    renewalTermPeriodType: string;
+    ratePlans: ZuoraRatePlan[];
+    createdDate: string;
+    updatedDate: string;
+}
+export interface ZuoraPayment {
+    id: string;
+    paymentNumber: string;
+    accountId: string;
+    accountNumber: string;
+    amount: number;
+    appliedAmount: number;
+    unappliedAmount: number;
+    effectiveDate: string;
+    status: string;
+    type: string;
+    gatewayResponse?: string;
+    gatewayResponseCode?: string;
+    paymentMethodType: string;
+    createdDate: string;
+    updatedDate: string;
+}
+export interface ZuoraQueryResult {
+    records: Record<string, unknown>[];
+    size: number;
+    queryLocator?: string;
+    done: boolean;
+}
+export interface ZuoraProduct {
+    id: string;
+    name: string;
+    sku: string;
+    description?: string;
+    category?: string;
+    effectiveStartDate: string;
+    effectiveEndDate: string;
+    productRatePlans: Array<{
+        id: string;
+        name: string;
+        description?: string;
+        productRatePlanCharges: Array<{
+            id: string;
+            name: string;
+            type: string;
+            model: string;
+            billingPeriod: string;
+            defaultQuantity?: number;
+            pricing: Array<{
+                currency: string;
+                price: number;
+            }>;
+        }>;
+    }>;
+}
+export interface ZuoraInvoiceFile {
+    id: string;
+    versionNumber: number;
+    pdfFileUrl: string;
+    createdDate: string;
+}
+export interface ZuoraInvoiceFilesResponse {
+    invoiceFiles?: ZuoraInvoiceFile[];
+    nextPage?: string;
+    success: boolean;
+}
+export interface ZuoraCreditMemoItem {
+    id: string;
+    amount: number;
+    description?: string;
+    serviceStartDate: string;
+    serviceEndDate: string;
+    sku?: string;
+    chargeName?: string;
+    subscriptionId?: string;
+    createdDate: string;
+}
+export interface ZuoraCreditMemo {
+    id: string;
+    number: string;
+    accountId: string;
+    invoiceId?: string;
+    status: string;
+    sourceType: string;
+    amount: number;
+    refundAmount?: number;
+    appliedAmount: number;
+    unappliedAmount: number;
+    memoDate: string;
+    targetDate?: string;
+    reasonCode?: string;
+    comment?: string;
+    items?: ZuoraCreditMemoItem[];
+    createdDate: string;
+    updatedDate: string;
+}
+export interface ZuoraCreditMemoListResponse {
+    creditMemos: ZuoraCreditMemo[];
+    nextPage?: string;
+    success: boolean;
+}
+export interface ZuoraUsageRecord {
+    id: string;
+    accountId: string;
+    accountNumber: string;
+    subscriptionNumber?: string;
+    unitOfMeasure: string;
+    quantity: number;
+    startDateTime: string;
+    endDateTime?: string;
+    description?: string;
+    status: string;
+    createdDate: string;
+}
+export interface ZuoraUsageListResponse {
+    usage: ZuoraUsageRecord[];
+    nextPage?: string;
+    success: boolean;
+}
+export interface ZuoraBillRun {
+    id: string;
+    billRunNumber: string;
+    status: "Pending" | "Processing" | "Completed" | "Error" | "Canceled" | "PostInProgress" | "Posted";
+    targetDate: string;
+    invoiceDate: string;
+    autoPost: boolean;
+    autoEmail: boolean;
+    name?: string;
+    createdDate: string;
+    updatedDate: string;
+}
+export interface ZuoraBillRunListResponse {
+    billRuns: ZuoraBillRun[];
+    nextPage?: string;
+    success: boolean;
+}
+export interface ZuoraCreateBillRunRequest {
+    targetDate: string;
+    invoiceDate?: string;
+    autoPost?: boolean;
+    autoEmail?: boolean;
+    name?: string;
+}
+export interface ZuoraCreateBillRunResponse {
+    id: string;
+    billRunNumber: string;
+    status: string;
+    targetDate: string;
+    success: boolean;
+}
+export interface ZuoraContactDetail {
+    id: string;
+    accountId: string;
+    firstName: string;
+    lastName: string;
+    workEmail?: string;
+    personalEmail?: string;
+    workPhone?: string;
+    homePhone?: string;
+    mobilePhone?: string;
+    fax?: string;
+    address1?: string;
+    address2?: string;
+    city?: string;
+    state?: string;
+    country?: string;
+    postalCode?: string;
+    county?: string;
+    taxRegion?: string;
+    description?: string;
+    nickname?: string;
+    createdDate: string;
+    updatedDate: string;
+}
+export interface ZuoraCreateContactRequest {
+    accountId: string;
+    firstName: string;
+    lastName: string;
+    workEmail?: string;
+    personalEmail?: string;
+    workPhone?: string;
+    homePhone?: string;
+    mobilePhone?: string;
+    fax?: string;
+    address1?: string;
+    address2?: string;
+    city?: string;
+    state?: string;
+    country?: string;
+    postalCode?: string;
+    county?: string;
+    taxRegion?: string;
+    description?: string;
+    nickname?: string;
+}
+export interface ZuoraCreateContactResponse {
+    id: string;
+    success: boolean;
+}
+export interface ZuoraUpdateContactRequest {
+    firstName?: string;
+    lastName?: string;
+    workEmail?: string;
+    personalEmail?: string;
+    workPhone?: string;
+    homePhone?: string;
+    mobilePhone?: string;
+    fax?: string;
+    address1?: string;
+    address2?: string;
+    city?: string;
+    state?: string;
+    country?: string;
+    postalCode?: string;
+    county?: string;
+    taxRegion?: string;
+    description?: string;
+    nickname?: string;
+}
+export interface ZuoraUpdateContactResponse {
+    success: boolean;
+}
+export interface ZuoraDescribeField {
+    name: string;
+    label: string;
+    type: string;
+    selectable: boolean;
+    createable: boolean;
+    updateable: boolean;
+    filterable: boolean;
+    custom: boolean;
+    required: boolean;
+    maxlength?: number;
+}
+export interface ZuoraDescribeResult {
+    objectName: string;
+    fields: ZuoraDescribeField[];
+    fieldCount: number;
+}
+export interface ZuoraCreatePaymentRequest {
+    accountId: string;
+    amount: number;
+    effectiveDate: string;
+    type: "Electronic" | "External";
+    paymentMethodId?: string;
+    comment?: string;
+}
+export interface ZuoraCreatePaymentResponse {
+    id: string;
+    paymentNumber: string;
+    amount: number;
+    effectiveDate: string;
+    status: string;
+    success: boolean;
+}
+export interface ZuoraPaymentInvoiceApplication {
+    invoiceId: string;
+    amount: number;
+}
+export interface ZuoraApplyPaymentRequest {
+    invoices: ZuoraPaymentInvoiceApplication[];
+    effectiveDate?: string;
+}
+export interface ZuoraApplyPaymentResponse {
+    id: string;
+    appliedAmount: number;
+    unappliedAmount: number;
+    status: string;
+    success: boolean;
+}
+export interface ZuoraCreateInvoiceRequest {
+    accountId: string;
+    invoiceDate: string;
+    dueDate?: string;
+}
+export interface ZuoraCreateInvoiceResponse {
+    id: string;
+    invoiceNumber: string;
+    accountId: string;
+    invoiceDate: string;
+    dueDate: string;
+    amount: number;
+    status: string;
+    success: boolean;
+}
+export interface ZuoraPostInvoiceResponse {
+    id: string;
+    invoiceNumber: string;
+    status: string;
+    success: boolean;
+}
+export interface ZuoraCancelSubscriptionRequest {
+    cancellationPolicy: "EndOfCurrentTerm" | "EndOfLastInvoicePeriod" | "SpecificDate";
+    cancellationEffectiveDate?: string;
+    invoiceCollect?: boolean;
+}
+export interface ZuoraCancelSubscriptionResponse {
+    subscriptionId: string;
+    cancelledDate: string;
+    totalDeltaMrr: number;
+    totalDeltaTcv: number;
+    success: boolean;
+}
+export interface ZuoraCreateSubscriptionRatePlan {
+    productRatePlanId: string;
+}
+export interface ZuoraCreateSubscriptionRequest {
+    accountKey: string;
+    contractEffectiveDate: string;
+    serviceActivationDate?: string;
+    customerAcceptanceDate?: string;
+    termType: "TERMED" | "EVERGREEN";
+    initialTerm?: number;
+    initialTermPeriodType?: "Month" | "Year" | "Day" | "Week";
+    renewalTerm?: number;
+    renewalTermPeriodType?: "Month" | "Year" | "Day" | "Week";
+    autoRenew?: boolean;
+    subscribeToRatePlans: ZuoraCreateSubscriptionRatePlan[];
+    notes?: string;
+}
+export interface ZuoraCreateSubscriptionResponse {
+    subscriptionId: string;
+    subscriptionNumber: string;
+    contractedMrr: number;
+    totalContractedValue: number;
+    success: boolean;
+}
+export interface ZuoraUpdateSubscriptionRequest {
+    autoRenew?: boolean;
+    renewalTerm?: number;
+    renewalTermPeriodType?: "Month" | "Year" | "Day" | "Week";
+    notes?: string;
+}
+export interface ZuoraUpdateSubscriptionResponse {
+    subscriptionId: string;
+    success: boolean;
+}
+export interface ZuoraContactRequest {
+    firstName: string;
+    lastName: string;
+    workEmail: string;
+    address1?: string;
+    city?: string;
+    state?: string;
+    postalCode?: string;
+    country?: string;
+}
+export interface ZuoraCreateAccountRequest {
+    name: string;
+    currency: string;
+    billCycleDay: number;
+    billToContact: ZuoraContactRequest;
+    soldToContact?: ZuoraContactRequest;
+    paymentTerm?: string;
+    autoPay?: boolean;
+    notes?: string;
+}
+export interface ZuoraCreateAccountResponse {
+    accountId: string;
+    accountNumber: string;
+    success: boolean;
+}
+export interface ZuoraUpdateAccountRequest {
+    name?: string;
+    notes?: string;
+    autoPay?: boolean;
+    paymentTerm?: string;
+    billToContact?: Partial<ZuoraContactRequest>;
+    soldToContact?: Partial<ZuoraContactRequest>;
+}
+export interface ZuoraUpdateAccountResponse {
+    success: boolean;
+}
+export interface ZuoraCreateRefundRequest {
+    amount: number;
+    type: "Electronic" | "External";
+    comment?: string;
+}
+export interface ZuoraCreateRefundResponse {
+    id: string;
+    number: string;
+    amount: number;
+    status: string;
+    success: boolean;
+}
+export interface ZuoraInvoiceListResponse {
+    invoices: ZuoraInvoice[];
+    nextPage?: string;
+    success: boolean;
+}
+export interface ZuoraSubscriptionListResponse {
+    subscriptions: ZuoraSubscription[];
+    success: boolean;
+}
+export interface ZuoraPaymentListResponse {
+    payments: ZuoraPayment[];
+    nextPage?: string;
+    success: boolean;
+}
+export interface ZuoraProductListResponse {
+    products: ZuoraProduct[];
+    nextPage?: string;
+    success: boolean;
+}
+export interface CompositeAccountWithSubscriptions {
+    accountId: string;
+    accountNumber: string;
+    accountName: string;
+    accountStatus: string;
+    subscriptions: Array<{
+        subscriptionId: string;
+        subscriptionNumber: string;
+        status: string;
+        termEndDate?: string;
+        ratePlanName?: string;
+    }>;
+}
+export interface OverdueInvoiceResult {
+    invoiceId: string;
+    invoiceNumber: string;
+    accountId: string;
+    accountNumber: string;
+    accountName: string;
+    invoiceDate: string;
+    dueDate: string;
+    amount: number;
+    balance: number;
+    daysPastDue: number;
+}
+export interface AgingBucket {
+    label: string;
+    minDays: number;
+    maxDays: number | null;
+    invoiceCount: number;
+    totalBalance: number;
+    invoices: Array<{
+        invoiceId: string;
+        invoiceNumber: string;
+        accountName: string;
+        accountNumber: string;
+        balance: number;
+        dueDate: string;
+        daysPastDue: number;
+    }>;
+}
+export interface ExpiringSubscriptionResult {
+    subscriptionId: string;
+    subscriptionNumber: string;
+    accountId: string;
+    accountNumber: string;
+    accountName: string;
+    status: string;
+    termEndDate: string;
+    autoRenew: boolean;
+    contractedMrr: number;
+    ratePlanNames: string[];
+    daysUntilExpiry: number;
+}
+export interface BillingOverviewResult {
+    account: {
+        id: string;
+        accountNumber: string;
+        name: string;
+        status: string;
+        balance: number;
+        currency: string;
+        autoPay: boolean;
+        paymentTerm: string;
+    };
+    invoiceSummary: {
+        totalOutstanding: number;
+        overdueCount: number;
+        overdueAmount: number;
+        recentInvoices: Array<{
+            invoiceNumber: string;
+            invoiceDate: string;
+            dueDate: string;
+            amount: number;
+            balance: number;
+            status: string;
+        }>;
+    };
+    paymentSummary: {
+        recentPayments: Array<{
+            paymentNumber: string;
+            amount: number;
+            effectiveDate: string;
+            status: string;
+        }>;
+    };
+    subscriptionSummary: {
+        activeCount: number;
+        totalMrr: number;
+        subscriptions: Array<{
+            subscriptionNumber: string;
+            status: string;
+            termEndDate: string;
+            contractedMrr: number;
+            ratePlanNames: string[];
+        }>;
+    };
+}
+export interface RevenueByProductResult {
+    productName: string;
+    subscriptionCount: number;
+    totalMrr: number;
+    totalTcv: number;
+    subscriptions: Array<{
+        subscriptionNumber: string;
+        accountNumber: string;
+        accountName: string;
+        mrr: number;
+        status: string;
+    }>;
+}
+export interface PaymentReconciliationResult {
+    period: {
+        startDate: string;
+        endDate: string;
+    };
+    summary: {
+        totalPayments: number;
+        totalAmount: number;
+        byStatus: Record<string, {
+            count: number;
+            amount: number;
+        }>;
+    };
+    payments: Array<{
+        paymentNumber: string;
+        accountNumber: string;
+        accountName: string;
+        amount: number;
+        effectiveDate: string;
+        status: string;
+        paymentMethodType: string;
+    }>;
+}
+export interface CancelledSubscriptionResult {
+    subscriptionId: string;
+    subscriptionNumber: string;
+    accountId: string;
+    accountNumber: string;
+    accountName: string;
+    status: string;
+    cancelledDate: string;
+    termEndDate: string;
+    contractedMrr: number;
+    ratePlanNames: string[];
+}
+export interface AccountHealthResult {
+    accountId: string;
+    accountNumber: string;
+    accountName: string;
+    healthScore: number;
+    riskFactors: string[];
+    overdueInvoices: {
+        count: number;
+        totalBalance: number;
+    };
+    expiringSubscriptions: {
+        count: number;
+        totalMrr: number;
+    };
+    recentPaymentFailures: number;
+}
+export interface ZuoraUser {
+    id: string;
+    userName: string;
+    status: string;
+    workEmail?: string;
+    firstName?: string;
+    lastName?: string;
+    roleId?: string;
+    profileId?: string;
+    createdDate?: string;
+    lastLoginTime?: string;
+}
+export interface ZuoraUserListResponse {
+    totalResults: number;
+    itemsPerPage: number;
+    startIndex: number;
+    Resources: ZuoraUser[];
+}
+export interface InvoiceByProductResult {
+    invoiceId: string;
+    invoiceNumber: string;
+    invoiceDate: string;
+    accountNumber: string;
+    accountName: string;
+    chargeAmount: number;
+    chargeName: string;
+    ratePlanName: string;
+    subscriptionNumber: string;
+}
+//# sourceMappingURL=types.d.ts.map