@zuora/agent-toolkit 0.0.1-alpha.0

package/dist/bundle-catalog-3V6EICKE.json

@@ -0,0 +1,289 @@
+{
+  "version": 1,
+  "bundles": {
+    "accounts": {
+      "description": "Customer accounts, contacts, billing profiles, and account summaries.",
+      "examples": [
+        "show account summary",
+        "find account by account number",
+        "update account contact",
+        "cancel customer account"
+      ],
+      "commonObjects": [
+        "Account",
+        "Contact",
+        "BillingProfile"
+      ],
+      "keywords": [
+        "account",
+        "customer",
+        "contact",
+        "billing profile",
+        "summary"
+      ]
+    },
+    "catalog": {
+      "description": "Products, plans, charges, tiers, pricing context, and commerce catalog setup.",
+      "examples": [
+        "show latest product",
+        "create product",
+        "update product charge",
+        "inspect pricing tiers"
+      ],
+      "commonObjects": [
+        "Product",
+        "Plan",
+        "Charge",
+        "Tier"
+      ],
+      "keywords": [
+        "product",
+        "catalog",
+        "plan",
+        "charge",
+        "price",
+        "tier"
+      ]
+    },
+    "subscriptions": {
+      "description": "Subscription lookup, previews, creation, changes, renewal, and cancellation.",
+      "examples": [
+        "show subscription",
+        "preview subscription change",
+        "create subscription",
+        "cancel subscription"
+      ],
+      "commonObjects": [
+        "Subscription",
+        "RatePlan",
+        "OrderAction"
+      ],
+      "keywords": [
+        "subscription",
+        "renewal",
+        "preview",
+        "amendment",
+        "cancel"
+      ]
+    },
+    "orders": {
+      "description": "Order preview and order lifecycle operations for subscription commerce changes.",
+      "examples": [
+        "preview order",
+        "create order",
+        "show order",
+        "cancel order"
+      ],
+      "commonObjects": [
+        "Order",
+        "OrderAction",
+        "OrderLineItem"
+      ],
+      "keywords": [
+        "order",
+        "order action",
+        "preview",
+        "subscription change"
+      ]
+    },
+    "billing": {
+      "description": "Invoices, bill runs, billing documents, credit memos, debit memos, and billing previews.",
+      "examples": [
+        "create bill run",
+        "check bill run status",
+        "show latest invoice",
+        "post bill run",
+        "generate billing documents"
+      ],
+      "commonObjects": [
+        "Invoice",
+        "BillRun",
+        "CreditMemo",
+        "DebitMemo",
+        "BillingPreview"
+      ],
+      "keywords": [
+        "invoice",
+        "bill run",
+        "billing",
+        "credit memo",
+        "debit memo",
+        "billing preview",
+        "pdf"
+      ]
+    },
+    "payments": {
+      "description": "Payments, payment runs, refunds, payment methods, and payment schedules.",
+      "examples": [
+        "show payment",
+        "refund payment",
+        "create payment run",
+        "inspect payment method"
+      ],
+      "commonObjects": [
+        "Payment",
+        "PaymentRun",
+        "Refund",
+        "PaymentMethod"
+      ],
+      "keywords": [
+        "payment",
+        "refund",
+        "payment method",
+        "payment run",
+        "settlement"
+      ]
+    },
+    "usage": {
+      "description": "Usage upload, usage query, chargeable events, and metered consumption operations.",
+      "examples": [
+        "upload usage",
+        "query usage records",
+        "inspect chargeable events"
+      ],
+      "commonObjects": [
+        "Usage",
+        "ChargeableEvent"
+      ],
+      "keywords": [
+        "usage",
+        "meter",
+        "consumption",
+        "chargeable event",
+        "upload"
+      ]
+    },
+    "revenue": {
+      "description": "Revenue reporting, journal runs, revenue schedules, and accounting recognition workflows.",
+      "examples": [
+        "show revenue schedule",
+        "run revenue report",
+        "check journal run status"
+      ],
+      "commonObjects": [
+        "RevenueSchedule",
+        "JournalRun",
+        "RevenueContract"
+      ],
+      "keywords": [
+        "revenue",
+        "journal",
+        "recognition",
+        "revenue schedule"
+      ]
+    },
+    "finance": {
+      "description": "Accounting periods, accounting codes, sequence sets, and finance configuration.",
+      "examples": [
+        "list accounting periods",
+        "close accounting period",
+        "show accounting code settings",
+        "update sequence set"
+      ],
+      "commonObjects": [
+        "AccountingPeriod",
+        "AccountingCode",
+        "SequenceSet"
+      ],
+      "keywords": [
+        "accounting",
+        "finance",
+        "period",
+        "sequence",
+        "trial balance"
+      ]
+    },
+    "workflows": {
+      "description": "Workflow discovery, execution, task status, and workflow monitoring.",
+      "examples": [
+        "list workflows",
+        "run workflow",
+        "check workflow task status"
+      ],
+      "commonObjects": [
+        "Workflow",
+        "WorkflowRun",
+        "WorkflowTask"
+      ],
+      "keywords": [
+        "workflow",
+        "task",
+        "automation",
+        "run",
+        "monitor"
+      ]
+    },
+    "query": {
+      "description": "Object Query, GraphQL Query, Data Query, metadata discovery, query jobs, and result retrieval.",
+      "examples": [
+        "manage_data_queries: query aggregations result like: how many active billing accounts",
+        "zuora_graphql__query: describe product object fields",
+        "zuora_graphql__query in sync mode: query nested subscription details",
+        "use query_objects for Object Query: simple object lookups, one primary object, small result sets, or object metadata and field discovery",
+        "use manage_data_queries: SQL-style reporting, joins, aggregations, or large read-only exports",
+        "use manage_data_queries for Data Query job status and result metadata",
+        "use download_query_result for completed Data Query result file downloads when a jobId is available",
+        "use zuora_graphql__query for nested related records in one response when the tenant exposes the needed graph schema",
+        "manage_data_queries: submit data query",
+        "manage_data_queries: check query job status"
+      ],
+      "commonObjects": [
+        "DataQueryJob",
+        "ObjectMetadata",
+        "QueryResult"
+      ],
+      "keywords": [
+        "query",
+        "data query",
+        "object",
+        "graphql",
+        "metadata",
+        "sql",
+        "job",
+        "result"
+      ]
+    },
+    "admin": {
+      "description": "Settings, custom fields, custom objects, feature configuration, and system health.",
+      "examples": [
+        "list custom fields",
+        "create custom object record",
+        "show tenant settings",
+        "check system health"
+      ],
+      "commonObjects": [
+        "CustomField",
+        "CustomObject",
+        "TenantSetting"
+      ],
+      "keywords": [
+        "admin",
+        "settings",
+        "custom field",
+        "custom object",
+        "tenant",
+        "health"
+      ]
+    },
+    "files": {
+      "description": "SDK-native file artifact downloads and bounded local artifact reads.",
+      "examples": [
+        "download data query result file",
+        "read downloaded file preview",
+        "inspect exported jsonl result"
+      ],
+      "commonObjects": [
+        "FileArtifact",
+        "DownloadedFile"
+      ],
+      "keywords": [
+        "file",
+        "download",
+        "artifact",
+        "jsonl",
+        "csv",
+        "result url"
+      ]
+    }
+  }
+}

package/dist/index.d.ts

@@ -0,0 +1,42 @@
+import { b as ZuoraToolExecutionResult, h as ZuoraBundleName } from './async-jobs-Dd8Jafv0.js';
+export { A as ApprovalPolicy, j as ApprovalPolicyPreset, k as ApprovalPolicyPresetValue, l as ApprovalRequest, D as DEFAULT_ASYNC_JOB_TERMINAL_STATUSES, N as NativeFileApprovalMetadata, m as NativeFileToolsConfig, n as NativeToolApprovalMetadata, o as NativeToolMetadataConfig, T as ToolSelection, p as ToolkitBundleName, e as ZuoraAgentToolkitConfig, a as ZuoraAgentToolkitConfigInput, c as ZuoraAsyncJobResult, q as ZuoraAsyncJobStatusResolution, r as ZuoraAsyncJobTerminalState, s as ZuoraAsyncJobTerminalStatuses, g as ZuoraBundleDefinition, t as ZuoraSafetyMode, Z as ZuoraToolDefinition, u as ZuoraToolkitConfiguration, d as ZuoraToolkitEvent, v as ZuoraToolkitLogger, i as ZuoraWaitForJobOptions, w as buildAsyncJobResult, x as isAsyncJobResult, y as isAsyncJobTerminal, z as matchesAsyncJobTerminalStatus, B as resolveAsyncJobId, C as resolveAsyncJobPollingToolName, E as resolveAsyncJobStatus, F as resolveAsyncJobStatusDetails, G as resolveAsyncJobTerminalState } from './async-jobs-Dd8Jafv0.js';
+
+type ZuoraAgentToolkitP0ErrorCode = "TOOL_EXECUTION_ERROR" | "TOOL_NOT_FOUND" | "BUNDLE_NOT_FOUND" | "APPROVAL_REJECTED" | "MALFORMED_METADATA" | "OAUTH_TOKEN_ERROR" | "ASYNC_JOB_TIMEOUT";
+type ZuoraAgentToolkitErrorCode = ZuoraAgentToolkitP0ErrorCode | (string & {});
+type ZuoraAgentToolkitP0ErrorCategory = "tool_execution" | "approval" | "metadata" | "auth";
+type ZuoraAgentToolkitErrorCategory = ZuoraAgentToolkitP0ErrorCategory | "permission" | "validation" | "zuora" | "mcp" | "configuration" | "native_file_tools";
+declare class ZuoraAgentToolkitError extends Error {
+    readonly code: ZuoraAgentToolkitErrorCode;
+    readonly category: ZuoraAgentToolkitErrorCategory;
+    readonly retryable: boolean;
+    readonly recoverable: boolean;
+    readonly requestId?: string | undefined;
+    readonly details?: unknown;
+    constructor(params: {
+        code: ZuoraAgentToolkitErrorCode;
+        message: string;
+        category: ZuoraAgentToolkitErrorCategory;
+        retryable?: boolean;
+        recoverable?: boolean;
+        requestId?: string;
+        details?: unknown;
+    });
+}
+
+type AgentToolFollowUpContext = {
+    /** Job id from a pending async job, when the caller already resolved it. */
+    asyncJobId?: string;
+};
+type AgentToolFollowUpResolution = {
+    followUpToolNames: string[];
+    requireToolOnNextStep: boolean;
+    recommendedNextTool?: string;
+    recommendedNextArgs?: Record<string, unknown>;
+    hasDownloadableOutput: boolean;
+};
+declare const resolveAgentToolFollowUps: (result: ZuoraToolExecutionResult, context?: AgentToolFollowUpContext) => AgentToolFollowUpResolution;
+declare const buildToolMessagePayload: (result: ZuoraToolExecutionResult, followUp: AgentToolFollowUpResolution) => Record<string, unknown>;
+
+declare const ZUORA_BUNDLE_NAME_SET: Set<ZuoraBundleName>;
+
+export { type AgentToolFollowUpResolution, ZUORA_BUNDLE_NAME_SET, ZuoraAgentToolkitError, type ZuoraAgentToolkitErrorCategory, type ZuoraAgentToolkitErrorCode, ZuoraBundleName, ZuoraToolExecutionResult, buildToolMessagePayload, resolveAgentToolFollowUps };