@gpt-platform/client 0.11.0 → 0.11.2

package/dist/namespaces/invoices.d.ts

@@ -0,0 +1,1055 @@
+import type { InvoicesInvoice, InvoicesLine, InvoicesPayment, InvoicesTemplate, InvoicesRule, InvoicesRecurringSchedule, InvoicesContact, InvoicesActivity } from "../_internal/types.gen";
+import type { RequestOptions } from "../base-client";
+import { RequestBuilder } from "../request-builder";
+/** Attributes accepted when creating an invoice. */
+export type CreateInvoiceAttributes = {
+    workspace_id: string;
+    direction?: string;
+    source?: string;
+    reference_number?: string;
+    contact_id?: string;
+    issue_date?: string;
+    due_date?: string;
+    currency?: string;
+    subtotal?: number;
+    tax_total?: number;
+    total?: number;
+    amount_paid?: number;
+    amount_due?: number;
+    payment_terms?: string;
+    notes?: string;
+    metadata?: Record<string, unknown>;
+    ai_confidence?: number;
+    ai_suggestions?: Record<string, unknown>;
+    template_id?: string;
+    recurring_schedule_id?: string;
+    extraction_result_id?: string;
+    billing_address?: Record<string, unknown>;
+    shipping_address?: Record<string, unknown>;
+    [key: string]: unknown;
+};
+/** Attributes accepted when updating an invoice (PATCH semantics). */
+export type UpdateInvoiceAttributes = {
+    reference_number?: string;
+    contact_id?: string;
+    issue_date?: string;
+    due_date?: string;
+    currency?: string;
+    payment_terms?: string;
+    notes?: string;
+    metadata?: Record<string, unknown>;
+    subtotal?: number;
+    tax_total?: number;
+    total?: number;
+    amount_paid?: number;
+    amount_due?: number;
+    billing_address?: Record<string, unknown>;
+    shipping_address?: Record<string, unknown>;
+    [key: string]: unknown;
+};
+/** Attributes accepted when creating an invoice line item. */
+export type CreateInvoiceLineAttributes = {
+    invoice_id: string;
+    position?: number;
+    description?: string;
+    quantity?: number;
+    unit_price?: number;
+    tax_rate?: number;
+    gl_code?: string;
+    category?: string;
+    ai_suggested_gl?: string;
+    ai_gl_confidence?: number;
+    metadata?: Record<string, unknown>;
+    [key: string]: unknown;
+};
+/** Attributes accepted when updating an invoice line item (PATCH semantics). */
+export type UpdateInvoiceLineAttributes = {
+    position?: number;
+    description?: string;
+    quantity?: number;
+    unit_price?: number;
+    tax_rate?: number;
+    gl_code?: string;
+    category?: string;
+    ai_suggested_gl?: string;
+    ai_gl_confidence?: number;
+    metadata?: Record<string, unknown>;
+    [key: string]: unknown;
+};
+/** Attributes accepted when creating a payment. */
+export type CreatePaymentAttributes = {
+    invoice_id: string;
+    amount: number;
+    currency?: string;
+    method?: string;
+    reference?: string;
+    provider_transaction_id?: string;
+    paid_at?: string;
+    notes?: string;
+    metadata?: Record<string, unknown>;
+    provider?: string;
+    [key: string]: unknown;
+};
+/** Attributes accepted when creating a template. */
+export type CreateTemplateAttributes = {
+    workspace_id: string;
+    name: string;
+    description?: string;
+    layout?: Record<string, unknown>;
+    default_payment_terms?: string;
+    default_notes?: string;
+    branding?: Record<string, unknown>;
+    is_default?: boolean;
+    metadata?: Record<string, unknown>;
+    [key: string]: unknown;
+};
+/** Attributes accepted when updating a template (PATCH semantics). */
+export type UpdateTemplateAttributes = {
+    name?: string;
+    description?: string;
+    layout?: Record<string, unknown>;
+    default_payment_terms?: string;
+    default_notes?: string;
+    branding?: Record<string, unknown>;
+    is_default?: boolean;
+    metadata?: Record<string, unknown>;
+    [key: string]: unknown;
+};
+/** Attributes accepted when creating a rule. */
+export type CreateRuleAttributes = {
+    workspace_id: string;
+    name: string;
+    rule_type?: string;
+    source?: string;
+    conditions?: Record<string, unknown>;
+    actions?: Record<string, unknown>;
+    confidence?: number;
+    active?: boolean;
+    metadata?: Record<string, unknown>;
+    [key: string]: unknown;
+};
+/** Attributes accepted when updating a rule (PATCH semantics). */
+export type UpdateRuleAttributes = {
+    name?: string;
+    conditions?: Record<string, unknown>;
+    actions?: Record<string, unknown>;
+    confidence?: number;
+    active?: boolean;
+    metadata?: Record<string, unknown>;
+    [key: string]: unknown;
+};
+/** Attributes accepted when creating a recurring schedule. */
+export type CreateRecurringScheduleAttributes = {
+    workspace_id: string;
+    contact_id?: string;
+    template_id?: string;
+    name: string;
+    frequency?: string;
+    start_date?: string;
+    end_date?: string;
+    next_run_date?: string;
+    line_items?: Record<string, unknown>[];
+    auto_send?: boolean;
+    active?: boolean;
+    metadata?: Record<string, unknown>;
+    [key: string]: unknown;
+};
+/** Attributes accepted when updating a recurring schedule (PATCH semantics). */
+export type UpdateRecurringScheduleAttributes = {
+    name?: string;
+    contact_id?: string;
+    template_id?: string;
+    frequency?: string;
+    end_date?: string;
+    line_items?: Record<string, unknown>[];
+    auto_send?: boolean;
+    metadata?: Record<string, unknown>;
+    [key: string]: unknown;
+};
+/** Attributes accepted when creating an invoices contact. */
+export type CreateContactAttributes = {
+    workspace_id: string;
+    name: string;
+    email?: string;
+    phone?: string;
+    tax_id?: string;
+    type?: string;
+    payment_terms_default?: string;
+    notes?: string;
+    metadata?: Record<string, unknown>;
+    [key: string]: unknown;
+};
+/** Attributes accepted when updating an invoices contact (PATCH semantics). */
+export type UpdateContactAttributes = {
+    name?: string;
+    email?: string;
+    phone?: string;
+    tax_id?: string;
+    type?: string;
+    payment_terms_default?: string;
+    notes?: string;
+    metadata?: Record<string, unknown>;
+    [key: string]: unknown;
+};
+export type { InvoicesInvoice, InvoicesLine, InvoicesPayment, InvoicesTemplate, InvoicesRule, InvoicesRecurringSchedule, InvoicesContact, InvoicesActivity, };
+/**
+ * Invoices namespace for invoice management, payments, templates, rules,
+ * recurring schedules, contacts, and activities.
+ *
+ * Provides sub-namespaces covering the full invoicing lifecycle: invoices
+ * (create, approve, send, track payments), line items, payments, templates,
+ * rules (AI-powered categorisation and GL coding), recurring schedules,
+ * contacts (invoice-specific contact records), and activities (audit trail).
+ *
+ * @example
+ * ```typescript
+ * const client = new GptClient({ apiKey: 'sk_app_...' });
+ *
+ * // Create an invoice
+ * const invoice = await client.invoices.invoices.create({
+ *   workspace_id: 'ws_abc123',
+ *   direction: 'outbound',
+ *   contact_id: 'con_xyz',
+ *   currency: 'USD',
+ * });
+ *
+ * // Add a line item
+ * await client.invoices.lines.create({
+ *   invoice_id: invoice.id,
+ *   description: 'Consulting services',
+ *   quantity: 10,
+ *   unit_price: 15000,
+ * });
+ *
+ * // Submit for approval and send
+ * await client.invoices.invoices.submitForApproval(invoice.id);
+ * await client.invoices.invoices.approve(invoice.id);
+ * await client.invoices.invoices.send(invoice.id);
+ * ```
+ */
+export declare function createInvoicesNamespace(rb: RequestBuilder): {
+    /**
+     * Invoices -- core invoice records and lifecycle management.
+     *
+     * Invoices progress through a state machine: draft -> submitted ->
+     * approved -> sent -> viewed -> paid (or voided/disputed at various
+     * stages). Each status transition is exposed as a dedicated method.
+     */
+    invoices: {
+        /**
+         * Fetch a single invoice by its unique ID.
+         *
+         * @param id - The unique identifier of the invoice to retrieve.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the matching {@link InvoicesInvoice}.
+         *
+         * @example
+         * ```typescript
+         * const invoice = await client.invoices.invoices.get('inv_abc123');
+         * console.log(invoice.attributes.status);
+         * ```
+         */
+        get: (id: string, options?: RequestOptions) => Promise<InvoicesInvoice>;
+        /**
+         * Create a new invoice.
+         *
+         * @param attributes - Key/value map of invoice attributes. Must include
+         *   `workspace_id`. Common fields include `direction`, `contact_id`,
+         *   `currency`, `issue_date`, and `due_date`.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the newly created {@link InvoicesInvoice}.
+         *
+         * @example
+         * ```typescript
+         * const invoice = await client.invoices.invoices.create({
+         *   workspace_id: 'ws_abc123',
+         *   direction: 'outbound',
+         *   contact_id: 'con_xyz',
+         *   currency: 'USD',
+         *   issue_date: '2026-03-28',
+         *   due_date: '2026-04-28',
+         * });
+         * console.log(invoice.id);
+         * ```
+         */
+        create: (attributes: CreateInvoiceAttributes, options?: RequestOptions) => Promise<InvoicesInvoice>;
+        /**
+         * Update an existing invoice's attributes.
+         *
+         * Only the fields present in `attributes` are changed (PATCH semantics).
+         *
+         * @param id - The unique identifier of the invoice to update.
+         * @param attributes - Key/value map of attributes to change.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link InvoicesInvoice}.
+         *
+         * @example
+         * ```typescript
+         * const invoice = await client.invoices.invoices.update('inv_abc123', {
+         *   due_date: '2026-05-01',
+         *   notes: 'Extended payment terms per agreement',
+         * });
+         * ```
+         */
+        update: (id: string, attributes: UpdateInvoiceAttributes, options?: RequestOptions) => Promise<InvoicesInvoice>;
+        /**
+         * Permanently delete an invoice.
+         *
+         * This is an irreversible hard delete. Only draft invoices should
+         * typically be deleted; use {@link void} for sent invoices.
+         *
+         * @param id - The unique identifier of the invoice to delete.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to `true` on successful deletion.
+         *
+         * @example
+         * ```typescript
+         * await client.invoices.invoices.delete('inv_abc123');
+         * ```
+         */
+        delete: (id: string, options?: RequestOptions) => Promise<true>;
+        /**
+         * List invoices in a workspace.
+         *
+         * Paginate large result sets with `page` and `pageSize`.
+         *
+         * @param workspaceId - The ID of the workspace to list invoices from.
+         * @param options - Optional pagination controls and request-level overrides.
+         * @returns A promise that resolves to an array of {@link InvoicesInvoice} records.
+         *
+         * @example
+         * ```typescript
+         * const invoices = await client.invoices.invoices.listByWorkspace('ws_abc123', {
+         *   page: 1,
+         *   pageSize: 25,
+         * });
+         * ```
+         */
+        listByWorkspace: (workspaceId: string, options?: {
+            page?: number;
+            pageSize?: number;
+        } & RequestOptions) => Promise<InvoicesInvoice[]>;
+        /**
+         * Submit an invoice for approval.
+         *
+         * Transitions the invoice from `draft` to `submitted` status.
+         *
+         * @param id - The unique identifier of the invoice to submit.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link InvoicesInvoice}.
+         *
+         * @example
+         * ```typescript
+         * const invoice = await client.invoices.invoices.submitForApproval('inv_abc123');
+         * console.log(invoice.attributes.status); // 'submitted'
+         * ```
+         */
+        submitForApproval: (id: string, options?: RequestOptions) => Promise<InvoicesInvoice>;
+        /**
+         * Approve an invoice.
+         *
+         * Transitions the invoice from `submitted` to `approved` status.
+         *
+         * @param id - The unique identifier of the invoice to approve.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link InvoicesInvoice}.
+         *
+         * @example
+         * ```typescript
+         * const invoice = await client.invoices.invoices.approve('inv_abc123');
+         * console.log(invoice.attributes.status); // 'approved'
+         * ```
+         */
+        approve: (id: string, options?: RequestOptions) => Promise<InvoicesInvoice>;
+        /**
+         * Send an invoice to its contact.
+         *
+         * Transitions the invoice from `approved` to `sent` status.
+         *
+         * @param id - The unique identifier of the invoice to send.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link InvoicesInvoice}.
+         *
+         * @example
+         * ```typescript
+         * const invoice = await client.invoices.invoices.send('inv_abc123');
+         * console.log(invoice.attributes.status); // 'sent'
+         * ```
+         */
+        send: (id: string, options?: RequestOptions) => Promise<InvoicesInvoice>;
+        /**
+         * Mark an invoice as viewed by the recipient.
+         *
+         * Transitions the invoice to `viewed` status.
+         *
+         * @param id - The unique identifier of the invoice to mark as viewed.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link InvoicesInvoice}.
+         *
+         * @example
+         * ```typescript
+         * const invoice = await client.invoices.invoices.markViewed('inv_abc123');
+         * console.log(invoice.attributes.status); // 'viewed'
+         * ```
+         */
+        markViewed: (id: string, options?: RequestOptions) => Promise<InvoicesInvoice>;
+        /**
+         * Void an invoice.
+         *
+         * Cancels the invoice and prevents further payment. A reason must be
+         * provided for audit purposes.
+         *
+         * @param id - The unique identifier of the invoice to void.
+         * @param voidedReason - A human-readable explanation for voiding.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link InvoicesInvoice}.
+         *
+         * @example
+         * ```typescript
+         * const invoice = await client.invoices.invoices.void('inv_abc123', 'Duplicate invoice');
+         * console.log(invoice.attributes.status); // 'voided'
+         * ```
+         */
+        void: (id: string, voidedReason: string, options?: RequestOptions) => Promise<InvoicesInvoice>;
+        /**
+         * Mark an invoice as overdue.
+         *
+         * Transitions the invoice to `overdue` status when payment has not
+         * been received by the due date.
+         *
+         * @param id - The unique identifier of the invoice to mark as overdue.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link InvoicesInvoice}.
+         *
+         * @example
+         * ```typescript
+         * const invoice = await client.invoices.invoices.markOverdue('inv_abc123');
+         * console.log(invoice.attributes.status); // 'overdue'
+         * ```
+         */
+        markOverdue: (id: string, options?: RequestOptions) => Promise<InvoicesInvoice>;
+        /**
+         * Dispute an invoice.
+         *
+         * Transitions the invoice to `disputed` status when the recipient
+         * raises a dispute about the invoice contents or charges.
+         *
+         * @param id - The unique identifier of the invoice to dispute.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link InvoicesInvoice}.
+         *
+         * @example
+         * ```typescript
+         * const invoice = await client.invoices.invoices.dispute('inv_abc123');
+         * console.log(invoice.attributes.status); // 'disputed'
+         * ```
+         */
+        dispute: (id: string, options?: RequestOptions) => Promise<InvoicesInvoice>;
+        /**
+         * Resolve a dispute on an invoice.
+         *
+         * Transitions the invoice out of `disputed` status back to a payable
+         * state.
+         *
+         * @param id - The unique identifier of the disputed invoice to resolve.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link InvoicesInvoice}.
+         *
+         * @example
+         * ```typescript
+         * const invoice = await client.invoices.invoices.resolveDispute('inv_abc123');
+         * ```
+         */
+        resolveDispute: (id: string, options?: RequestOptions) => Promise<InvoicesInvoice>;
+        /**
+         * Schedule a payment for an invoice.
+         *
+         * Transitions the invoice to `payment_scheduled` status.
+         *
+         * @param id - The unique identifier of the invoice to schedule payment for.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link InvoicesInvoice}.
+         *
+         * @example
+         * ```typescript
+         * const invoice = await client.invoices.invoices.schedulePayment('inv_abc123');
+         * ```
+         */
+        schedulePayment: (id: string, options?: RequestOptions) => Promise<InvoicesInvoice>;
+        /**
+         * Mark an invoice as paid.
+         *
+         * Transitions the invoice to `paid` status. Typically called after
+         * a payment has been recorded via the payments namespace.
+         *
+         * @param id - The unique identifier of the invoice to mark as paid.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link InvoicesInvoice}.
+         *
+         * @example
+         * ```typescript
+         * const invoice = await client.invoices.invoices.markPaid('inv_abc123');
+         * console.log(invoice.attributes.status); // 'paid'
+         * ```
+         */
+        markPaid: (id: string, options?: RequestOptions) => Promise<InvoicesInvoice>;
+        /**
+         * Apply AI-generated suggestions to an invoice.
+         *
+         * Accepts a list of suggestion keys to apply from the invoice's
+         * `ai_suggestions` field. Only the specified keys are applied.
+         *
+         * @param id - The unique identifier of the invoice.
+         * @param acceptedKeys - Array of suggestion keys to accept and apply.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link InvoicesInvoice}.
+         *
+         * @example
+         * ```typescript
+         * const invoice = await client.invoices.invoices.applyAiSuggestions('inv_abc123', [
+         *   'contact_id',
+         *   'gl_codes',
+         * ]);
+         * ```
+         */
+        applyAiSuggestions: (id: string, acceptedKeys: string[], options?: RequestOptions) => Promise<InvoicesInvoice>;
+    };
+    /**
+     * Lines -- invoice line items.
+     *
+     * Each invoice contains one or more line items that describe the goods
+     * or services being billed. Lines include quantity, unit price, tax rate,
+     * and optional GL coding (which may be AI-suggested).
+     */
+    lines: {
+        /**
+         * Fetch a single invoice line item by its unique ID.
+         *
+         * @param id - The unique identifier of the line item to retrieve.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the matching {@link InvoicesLine}.
+         *
+         * @example
+         * ```typescript
+         * const line = await client.invoices.lines.get('line_abc123');
+         * console.log(line.attributes.description);
+         * ```
+         */
+        get: (id: string, options?: RequestOptions) => Promise<InvoicesLine>;
+        /**
+         * Create a new line item on an invoice.
+         *
+         * @param attributes - Key/value map of line attributes. Must include
+         *   `invoice_id`. Common fields include `description`, `quantity`,
+         *   `unit_price`, and `tax_rate`.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the newly created {@link InvoicesLine}.
+         *
+         * @example
+         * ```typescript
+         * const line = await client.invoices.lines.create({
+         *   invoice_id: 'inv_abc123',
+         *   description: 'Consulting services',
+         *   quantity: 10,
+         *   unit_price: 15000,
+         *   tax_rate: 0.1,
+         * });
+         * ```
+         */
+        create: (attributes: CreateInvoiceLineAttributes, options?: RequestOptions) => Promise<InvoicesLine>;
+        /**
+         * Update an existing line item's attributes.
+         *
+         * Only the fields present in `attributes` are changed (PATCH semantics).
+         *
+         * @param id - The unique identifier of the line item to update.
+         * @param attributes - Key/value map of attributes to change.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link InvoicesLine}.
+         *
+         * @example
+         * ```typescript
+         * const line = await client.invoices.lines.update('line_abc123', {
+         *   quantity: 15,
+         *   unit_price: 12000,
+         * });
+         * ```
+         */
+        update: (id: string, attributes: UpdateInvoiceLineAttributes, options?: RequestOptions) => Promise<InvoicesLine>;
+        /**
+         * Permanently delete a line item.
+         *
+         * @param id - The unique identifier of the line item to delete.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to `true` on successful deletion.
+         *
+         * @example
+         * ```typescript
+         * await client.invoices.lines.delete('line_abc123');
+         * ```
+         */
+        delete: (id: string, options?: RequestOptions) => Promise<true>;
+    };
+    /**
+     * Payments -- payment records against invoices.
+     *
+     * Each payment represents a financial transaction applied to an invoice.
+     * An invoice may have multiple partial payments. Payments are immutable
+     * once created (no update endpoint); delete and re-create if correction
+     * is needed.
+     */
+    payments: {
+        /**
+         * Fetch a single payment by its unique ID.
+         *
+         * @param id - The unique identifier of the payment to retrieve.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the matching {@link InvoicesPayment}.
+         *
+         * @example
+         * ```typescript
+         * const payment = await client.invoices.payments.get('pay_abc123');
+         * console.log(payment.attributes.amount);
+         * ```
+         */
+        get: (id: string, options?: RequestOptions) => Promise<InvoicesPayment>;
+        /**
+         * Record a new payment against an invoice.
+         *
+         * @param attributes - Key/value map of payment attributes. Must include
+         *   `invoice_id` and `amount`. Common fields include `currency`,
+         *   `method`, `reference`, and `paid_at`.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the newly created {@link InvoicesPayment}.
+         *
+         * @example
+         * ```typescript
+         * const payment = await client.invoices.payments.create({
+         *   invoice_id: 'inv_abc123',
+         *   amount: 50000,
+         *   currency: 'USD',
+         *   method: 'bank_transfer',
+         *   reference: 'TXN-12345',
+         *   paid_at: '2026-03-28T10:00:00Z',
+         * });
+         * ```
+         */
+        create: (attributes: CreatePaymentAttributes, options?: RequestOptions) => Promise<InvoicesPayment>;
+        /**
+         * Delete a payment record.
+         *
+         * @param id - The unique identifier of the payment to delete.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to `true` on successful deletion.
+         *
+         * @example
+         * ```typescript
+         * await client.invoices.payments.delete('pay_abc123');
+         * ```
+         */
+        delete: (id: string, options?: RequestOptions) => Promise<true>;
+    };
+    /**
+     * Templates -- reusable invoice templates.
+     *
+     * Templates define default layouts, payment terms, notes, and branding
+     * that are applied when creating new invoices. One template per workspace
+     * can be marked as the default.
+     */
+    templates: {
+        /**
+         * Fetch a single template by its unique ID.
+         *
+         * @param id - The unique identifier of the template to retrieve.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the matching {@link InvoicesTemplate}.
+         *
+         * @example
+         * ```typescript
+         * const template = await client.invoices.templates.get('tpl_abc123');
+         * console.log(template.attributes.name);
+         * ```
+         */
+        get: (id: string, options?: RequestOptions) => Promise<InvoicesTemplate>;
+        /**
+         * Create a new invoice template.
+         *
+         * @param attributes - Key/value map of template attributes. Must include
+         *   `workspace_id` and `name`.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the newly created {@link InvoicesTemplate}.
+         *
+         * @example
+         * ```typescript
+         * const template = await client.invoices.templates.create({
+         *   workspace_id: 'ws_abc123',
+         *   name: 'Standard Invoice',
+         *   default_payment_terms: 'Net 30',
+         *   is_default: true,
+         * });
+         * ```
+         */
+        create: (attributes: CreateTemplateAttributes, options?: RequestOptions) => Promise<InvoicesTemplate>;
+        /**
+         * Update an existing template's attributes.
+         *
+         * Only the fields present in `attributes` are changed (PATCH semantics).
+         *
+         * @param id - The unique identifier of the template to update.
+         * @param attributes - Key/value map of attributes to change.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link InvoicesTemplate}.
+         *
+         * @example
+         * ```typescript
+         * const template = await client.invoices.templates.update('tpl_abc123', {
+         *   default_payment_terms: 'Net 60',
+         * });
+         * ```
+         */
+        update: (id: string, attributes: UpdateTemplateAttributes, options?: RequestOptions) => Promise<InvoicesTemplate>;
+        /**
+         * Permanently delete a template.
+         *
+         * @param id - The unique identifier of the template to delete.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to `true` on successful deletion.
+         *
+         * @example
+         * ```typescript
+         * await client.invoices.templates.delete('tpl_abc123');
+         * ```
+         */
+        delete: (id: string, options?: RequestOptions) => Promise<true>;
+    };
+    /**
+     * Rules -- AI-powered categorisation and GL coding rules.
+     *
+     * Rules define conditions and actions for automatically categorising
+     * invoice line items, suggesting GL codes, and applying other
+     * transformations. Rules can be deactivated without deletion.
+     */
+    rules: {
+        /**
+         * Fetch a single rule by its unique ID.
+         *
+         * @param id - The unique identifier of the rule to retrieve.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the matching {@link InvoicesRule}.
+         *
+         * @example
+         * ```typescript
+         * const rule = await client.invoices.rules.get('rule_abc123');
+         * console.log(rule.attributes.name);
+         * ```
+         */
+        get: (id: string, options?: RequestOptions) => Promise<InvoicesRule>;
+        /**
+         * Create a new rule.
+         *
+         * @param attributes - Key/value map of rule attributes. Must include
+         *   `workspace_id` and `name`. Common fields include `rule_type`,
+         *   `conditions`, `actions`, and `confidence`.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the newly created {@link InvoicesRule}.
+         *
+         * @example
+         * ```typescript
+         * const rule = await client.invoices.rules.create({
+         *   workspace_id: 'ws_abc123',
+         *   name: 'Auto-categorise office supplies',
+         *   rule_type: 'categorisation',
+         *   conditions: { description_contains: 'office' },
+         *   actions: { gl_code: '6000', category: 'Office Supplies' },
+         * });
+         * ```
+         */
+        create: (attributes: CreateRuleAttributes, options?: RequestOptions) => Promise<InvoicesRule>;
+        /**
+         * Update an existing rule's attributes.
+         *
+         * Only the fields present in `attributes` are changed (PATCH semantics).
+         *
+         * @param id - The unique identifier of the rule to update.
+         * @param attributes - Key/value map of attributes to change.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link InvoicesRule}.
+         *
+         * @example
+         * ```typescript
+         * const rule = await client.invoices.rules.update('rule_abc123', {
+         *   confidence: 0.95,
+         *   actions: { gl_code: '6100', category: 'IT Equipment' },
+         * });
+         * ```
+         */
+        update: (id: string, attributes: UpdateRuleAttributes, options?: RequestOptions) => Promise<InvoicesRule>;
+        /**
+         * Permanently delete a rule.
+         *
+         * For reversible removal, prefer {@link deactivate} instead.
+         *
+         * @param id - The unique identifier of the rule to delete.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to `true` on successful deletion.
+         *
+         * @example
+         * ```typescript
+         * await client.invoices.rules.delete('rule_abc123');
+         * ```
+         */
+        delete: (id: string, options?: RequestOptions) => Promise<true>;
+        /**
+         * Deactivate a rule without deleting it.
+         *
+         * The rule remains in the system but is no longer applied to new
+         * invoices. It can be reactivated by updating `active` to `true`.
+         *
+         * @param id - The unique identifier of the rule to deactivate.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link InvoicesRule}.
+         *
+         * @example
+         * ```typescript
+         * const rule = await client.invoices.rules.deactivate('rule_abc123');
+         * console.log(rule.attributes.active); // false
+         * ```
+         */
+        deactivate: (id: string, options?: RequestOptions) => Promise<InvoicesRule>;
+    };
+    /**
+     * Recurring Schedules -- automated invoice generation on a schedule.
+     *
+     * Recurring schedules define templates and frequencies for automatically
+     * generating invoices. Schedules can be paused and resumed without
+     * deletion.
+     */
+    recurringSchedules: {
+        /**
+         * Fetch a single recurring schedule by its unique ID.
+         *
+         * @param id - The unique identifier of the schedule to retrieve.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the matching {@link InvoicesRecurringSchedule}.
+         *
+         * @example
+         * ```typescript
+         * const schedule = await client.invoices.recurringSchedules.get('sched_abc123');
+         * console.log(schedule.attributes.frequency);
+         * ```
+         */
+        get: (id: string, options?: RequestOptions) => Promise<InvoicesRecurringSchedule>;
+        /**
+         * Create a new recurring schedule.
+         *
+         * @param attributes - Key/value map of schedule attributes. Must include
+         *   `workspace_id` and `name`. Common fields include `frequency`,
+         *   `contact_id`, `template_id`, `start_date`, and `line_items`.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the newly created {@link InvoicesRecurringSchedule}.
+         *
+         * @example
+         * ```typescript
+         * const schedule = await client.invoices.recurringSchedules.create({
+         *   workspace_id: 'ws_abc123',
+         *   name: 'Monthly retainer',
+         *   contact_id: 'con_xyz',
+         *   frequency: 'monthly',
+         *   start_date: '2026-04-01',
+         *   auto_send: true,
+         * });
+         * ```
+         */
+        create: (attributes: CreateRecurringScheduleAttributes, options?: RequestOptions) => Promise<InvoicesRecurringSchedule>;
+        /**
+         * Update an existing recurring schedule's attributes.
+         *
+         * Only the fields present in `attributes` are changed (PATCH semantics).
+         *
+         * @param id - The unique identifier of the schedule to update.
+         * @param attributes - Key/value map of attributes to change.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link InvoicesRecurringSchedule}.
+         *
+         * @example
+         * ```typescript
+         * const schedule = await client.invoices.recurringSchedules.update('sched_abc123', {
+         *   frequency: 'quarterly',
+         *   auto_send: false,
+         * });
+         * ```
+         */
+        update: (id: string, attributes: UpdateRecurringScheduleAttributes, options?: RequestOptions) => Promise<InvoicesRecurringSchedule>;
+        /**
+         * Permanently delete a recurring schedule.
+         *
+         * For reversible removal, prefer {@link pause} instead.
+         *
+         * @param id - The unique identifier of the schedule to delete.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to `true` on successful deletion.
+         *
+         * @example
+         * ```typescript
+         * await client.invoices.recurringSchedules.delete('sched_abc123');
+         * ```
+         */
+        delete: (id: string, options?: RequestOptions) => Promise<true>;
+        /**
+         * Pause a recurring schedule.
+         *
+         * The schedule remains in the system but no new invoices will be
+         * generated until it is resumed via {@link resume}.
+         *
+         * @param id - The unique identifier of the schedule to pause.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link InvoicesRecurringSchedule}.
+         *
+         * @example
+         * ```typescript
+         * const schedule = await client.invoices.recurringSchedules.pause('sched_abc123');
+         * console.log(schedule.attributes.active); // false
+         * ```
+         */
+        pause: (id: string, options?: RequestOptions) => Promise<InvoicesRecurringSchedule>;
+        /**
+         * Resume a paused recurring schedule.
+         *
+         * Reactivates the schedule so that invoices will be generated on the
+         * next scheduled date.
+         *
+         * @param id - The unique identifier of the schedule to resume.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link InvoicesRecurringSchedule}.
+         *
+         * @example
+         * ```typescript
+         * const schedule = await client.invoices.recurringSchedules.resume('sched_abc123');
+         * console.log(schedule.attributes.active); // true
+         * ```
+         */
+        resume: (id: string, options?: RequestOptions) => Promise<InvoicesRecurringSchedule>;
+    };
+    /**
+     * Contacts -- invoice-specific contact records.
+     *
+     * Invoices contacts represent the billing entities (customers or vendors)
+     * associated with invoices. They may link to CRM contacts but maintain
+     * their own billing-specific attributes like tax IDs and default payment
+     * terms.
+     */
+    contacts: {
+        /**
+         * Fetch a single invoices contact by their unique ID.
+         *
+         * @param id - The unique identifier of the contact to retrieve.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the matching {@link InvoicesContact}.
+         *
+         * @example
+         * ```typescript
+         * const contact = await client.invoices.contacts.get('icon_abc123');
+         * console.log(contact.attributes.name);
+         * ```
+         */
+        get: (id: string, options?: RequestOptions) => Promise<InvoicesContact>;
+        /**
+         * Create a new invoices contact.
+         *
+         * @param attributes - Key/value map of contact attributes. Must include
+         *   `workspace_id` and `name`. Common fields include `email`, `phone`,
+         *   `tax_id`, and `payment_terms_default`.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the newly created {@link InvoicesContact}.
+         *
+         * @example
+         * ```typescript
+         * const contact = await client.invoices.contacts.create({
+         *   workspace_id: 'ws_abc123',
+         *   name: 'Acme Corp',
+         *   email: 'billing@acme.com',
+         *   tax_id: 'US-12-3456789',
+         *   payment_terms_default: 'Net 30',
+         * });
+         * ```
+         */
+        create: (attributes: CreateContactAttributes, options?: RequestOptions) => Promise<InvoicesContact>;
+        /**
+         * Update an existing invoices contact's attributes.
+         *
+         * Only the fields present in `attributes` are changed (PATCH semantics).
+         *
+         * @param id - The unique identifier of the contact to update.
+         * @param attributes - Key/value map of attributes to change.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link InvoicesContact}.
+         *
+         * @example
+         * ```typescript
+         * const contact = await client.invoices.contacts.update('icon_abc123', {
+         *   payment_terms_default: 'Net 60',
+         * });
+         * ```
+         */
+        update: (id: string, attributes: UpdateContactAttributes, options?: RequestOptions) => Promise<InvoicesContact>;
+        /**
+         * Permanently delete an invoices contact.
+         *
+         * @param id - The unique identifier of the contact to delete.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to `true` on successful deletion.
+         *
+         * @example
+         * ```typescript
+         * await client.invoices.contacts.delete('icon_abc123');
+         * ```
+         */
+        delete: (id: string, options?: RequestOptions) => Promise<true>;
+        /**
+         * List invoices contacts in a workspace.
+         *
+         * Paginate large result sets with `page` and `pageSize`.
+         *
+         * @param workspaceId - The ID of the workspace to list contacts from.
+         * @param options - Optional pagination controls and request-level overrides.
+         * @returns A promise that resolves to an array of {@link InvoicesContact} records.
+         *
+         * @example
+         * ```typescript
+         * const contacts = await client.invoices.contacts.listByWorkspace('ws_abc123', {
+         *   page: 1,
+         *   pageSize: 50,
+         * });
+         * ```
+         */
+        listByWorkspace: (workspaceId: string, options?: {
+            page?: number;
+            pageSize?: number;
+        } & RequestOptions) => Promise<InvoicesContact[]>;
+    };
+    /**
+     * Activities -- read-only audit trail of invoice events.
+     *
+     * Activities record all significant events in the invoice lifecycle:
+     * creation, status transitions, payments, AI suggestions applied, etc.
+     * Activities are system-generated and cannot be created or modified
+     * through the API.
+     */
+    activities: {
+        /**
+         * Fetch a single activity by its unique ID.
+         *
+         * @param id - The unique identifier of the activity to retrieve.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the matching {@link InvoicesActivity}.
+         *
+         * @example
+         * ```typescript
+         * const activity = await client.invoices.activities.get('act_abc123');
+         * console.log(activity.attributes.activity_type);
+         * ```
+         */
+        get: (id: string, options?: RequestOptions) => Promise<InvoicesActivity>;
+    };
+};
+//# sourceMappingURL=invoices.d.ts.map