@graph8/sdk 0.251.0 → 0.260.0

package/dist/types/quotes.d.ts

@@ -0,0 +1,143 @@
+export interface QuoteLineItem {
+    product_id?: string | null;
+    name?: string | null;
+    description?: string | null;
+    quantity: number;
+    unit_price: number;
+    currency?: string | null;
+    recurring?: boolean | null;
+}
+export type QuoteStatus = "draft" | "sent" | "signed" | "declined" | "expired" | "void";
+export interface QuoteSummary {
+    id: string;
+    name: string | null;
+    status: QuoteStatus;
+    total: number | null;
+    currency: string | null;
+    contact_id: number | null;
+    company_id: number | null;
+    expires_at: string | null;
+    created_at: string | null;
+    updated_at: string | null;
+    signing_url: string | null;
+    payment_link_url: string | null;
+}
+export interface QuoteDetail extends QuoteSummary {
+    line_items: QuoteLineItem[];
+    notes: string | null;
+    recipient_email: string | null;
+    signed_at: string | null;
+    sent_at: string | null;
+}
+export interface QuoteCreateParams {
+    contact_id?: number;
+    company_id?: number;
+    line_items: QuoteLineItem[];
+    currency?: string;
+    notes?: string;
+    /** ISO 8601 timestamp. */
+    expires_at?: string;
+    name?: string;
+}
+export interface QuoteUpdateParams {
+    line_items?: QuoteLineItem[];
+    notes?: string;
+    expires_at?: string;
+    name?: string;
+}
+export interface QuoteSendParams {
+    recipient_email: string;
+    /** Whether to attach the signing link. Defaults to true. */
+    send_signing_link?: boolean;
+}
+export interface QuoteListParams {
+    status?: QuoteStatus;
+    contact_id?: number;
+    company_id?: number;
+    page?: number;
+    limit?: number;
+}
+export interface QuotableProduct {
+    id: string;
+    name: string;
+    description: string | null;
+    unit_price: number;
+    currency: string;
+    recurring: boolean;
+}
+export interface QuoteSettings {
+    default_currency: string;
+    default_tax_rate: number | null;
+    payment_providers: string[];
+    logo_url: string | null;
+    signature_required: boolean;
+}
+export interface PaginationMeta {
+    page: number;
+    limit: number;
+    total: number;
+    has_next: boolean;
+}
+/**
+ * Quotes API - quote-to-cash lifecycle. Requires API key (server-side). On the
+ * hardened HTTP core: throws a typed `G8Error` on failure and retries transient
+ * errors.
+ *
+ * Backed by:
+ *   GET    /api/v1/quotes
+ *   GET    /api/v1/quotes/{id}
+ *   POST   /api/v1/quotes
+ *   PUT    /api/v1/quotes/{id}
+ *   DELETE /api/v1/quotes/{id}
+ *   POST   /api/v1/quotes/{id}/duplicate
+ *   POST   /api/v1/quotes/{id}/edit-as-draft
+ *   POST   /api/v1/quotes/{id}/send
+ *   GET    /api/v1/quotable-products
+ *   GET    /api/v1/quote-settings
+ *   GET    /api/v1/contacts/{contact_id}/quotes
+ *   GET    /api/v1/companies/{company_id}/quotes
+ */
+export declare const createQuotesClient: (apiKey: string, apiUrl?: string) => {
+    /** List quotes org-wide with optional filters and pagination. */
+    list(params?: QuoteListParams): Promise<{
+        data: QuoteSummary[];
+        pagination?: PaginationMeta;
+    }>;
+    /** Get full details for a single quote. */
+    get(quoteId: string): Promise<QuoteDetail>;
+    /** Create a new quote from line items. */
+    create(quote: QuoteCreateParams): Promise<QuoteDetail>;
+    /** Update a draft quote (line items, expiry, notes). */
+    update(quoteId: string, fields: QuoteUpdateParams): Promise<QuoteDetail>;
+    /** Delete a draft quote (irreversible). */
+    delete(quoteId: string): Promise<{
+        data: {
+            deleted: boolean;
+        };
+    }>;
+    /** Duplicate an existing quote (all line items copied into a new draft). */
+    duplicate(quoteId: string): Promise<QuoteDetail>;
+    /** Convert a signed / sent quote back to editable draft state. */
+    editAsDraft(quoteId: string): Promise<{
+        data: {
+            id: string;
+            status: string;
+        };
+    }>;
+    /** Send a quote to its recipient via email (with signature + optional payment link). */
+    send(quoteId: string, params: QuoteSendParams): Promise<QuoteDetail>;
+    /** List products available for line items. */
+    products(): Promise<{
+        data: QuotableProduct[];
+    }>;
+    /** Get org-level quote settings (currency, tax rate, payment providers, logo). */
+    settings(): Promise<QuoteSettings>;
+    /** Get all quotes associated with a contact. */
+    forContact(contactId: number): Promise<{
+        data: QuoteSummary[];
+    }>;
+    /** Get all quotes associated with a company. */
+    forCompany(companyId: number): Promise<{
+        data: QuoteSummary[];
+    }>;
+};