@gpt-platform/client 0.10.5 → 0.11.1

package/dist/namespaces/support.d.ts

@@ -0,0 +1,427 @@
+import type { SupportTicket, SupportTicketMessage, SupportTag, SupportTicketRating } from "../_internal/types.gen";
+/** Attributes accepted when creating a new support ticket. */
+export type CreateSupportTicketAttributes = {
+    workspace_id: string;
+    subject: string;
+    description?: string;
+    priority?: "low" | "normal" | "high" | "urgent";
+    contact_id?: string;
+    assignee_id?: string;
+    tags?: string[];
+    [key: string]: unknown;
+};
+/** Attributes accepted when updating an existing support ticket (PATCH semantics). */
+export type UpdateSupportTicketAttributes = {
+    subject?: string;
+    description?: string;
+    status?: string;
+    priority?: "low" | "normal" | "high" | "urgent";
+    assignee_id?: string;
+    resolution_note?: string;
+    tags?: string[];
+    [key: string]: unknown;
+};
+/** Attributes accepted when adding a message to a ticket. */
+export type CreateTicketMessageAttributes = {
+    body?: string;
+    body_html?: string;
+    author_type: "agent" | "customer";
+    author_id?: string;
+    attachments?: unknown[];
+    [key: string]: unknown;
+};
+/** Attributes accepted when rating a resolved ticket. */
+export type CreateTicketRatingAttributes = {
+    ticket_id: string;
+    rating: number;
+    comment?: string;
+    [key: string]: unknown;
+};
+/** Attributes accepted when creating a support tag. */
+export type CreateSupportTagAttributes = {
+    workspace_id: string;
+    name: string;
+    [key: string]: unknown;
+};
+import type { RequestOptions } from "../base-client";
+import { RequestBuilder } from "../request-builder";
+/**
+ * Support namespace for ticket management, queues, and SLA tracking.
+ *
+ * Provides sub-namespaces for the full support workflow: tickets (the core
+ * support interaction record with threaded messages and CSAT ratings) and
+ * tags (workspace-scoped labels used to categorise and filter tickets).
+ *
+ * @example
+ * ```typescript
+ * const client = new GptClient({ apiKey: 'sk_app_...' });
+ *
+ * // Open a ticket and add an initial message
+ * const ticket = await client.support.tickets.create({
+ *   workspace_id: 'ws_abc123',
+ *   subject: 'Cannot log in to my account',
+ *   description: 'I get a 401 error every time I try to sign in.',
+ *   priority: 'high',
+ * });
+ *
+ * await client.support.tickets.addMessage(ticket.id, {
+ *   body: 'Could you please provide your account email?',
+ *   author_type: 'agent',
+ * });
+ * ```
+ */
+export declare function createSupportNamespace(rb: RequestBuilder): {
+    /**
+     * Tickets — customer support ticket management.
+     *
+     * A ticket represents a single support interaction thread between a
+     * customer and a support agent (human or AI). Tickets have a subject,
+     * priority, status (open / pending / resolved / closed), and an ordered
+     * list of messages. End users can submit a 1–5 CSAT rating after their
+     * ticket is resolved via the {@link rate} method.
+     */
+    tickets: {
+        /**
+         * List open and active tickets for a workspace with optional pagination.
+         *
+         * Returns tickets ordered by creation time descending. To filter by
+         * status, priority, or tag, use the standard query parameters available
+         * on the underlying API endpoint.
+         *
+         * @param workspaceId - The ID of the workspace whose tickets to list.
+         * @param options - Optional pagination controls (`page`, `pageSize`) and
+         *   request-level overrides.
+         * @returns A promise that resolves to an array of {@link SupportTicket} records.
+         *
+         * @example
+         * ```typescript
+         * const client = new GptClient({ apiKey: 'sk_app_...' });
+         *
+         * const tickets = await client.support.tickets.list('ws_abc123', {
+         *   pageSize: 25,
+         * });
+         * const open = tickets.filter((t) => t.attributes.status === 'open');
+         * console.log(`${open.length} open tickets`);
+         * ```
+         */
+        list: (workspaceId: string, options?: {
+            page?: number;
+            pageSize?: number;
+        } & RequestOptions) => Promise<SupportTicket[]>;
+        /**
+         * Fetch a single support ticket by its unique ID.
+         *
+         * @param id - The unique identifier of the ticket to retrieve.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the matching {@link SupportTicket}.
+         *
+         * @example
+         * ```typescript
+         * const client = new GptClient({ apiKey: 'sk_app_...' });
+         *
+         * const ticket = await client.support.tickets.get('tkt_abc123');
+         * console.log(ticket.attributes.subject, ticket.attributes.status);
+         * ```
+         */
+        get: (id: string, options?: RequestOptions) => Promise<SupportTicket>;
+        /**
+         * Create a new support ticket.
+         *
+         * Tickets start with `status: 'open'` by default. Supply a `subject`
+         * and `description` to give agents enough context. Set `priority` to
+         * one of `"low"`, `"normal"`, `"high"`, or `"urgent"` based on
+         * customer impact.
+         *
+         * @param attributes - Key/value map of ticket attributes. Must include
+         *   `workspace_id` and `subject`. Common fields: `description`,
+         *   `priority`, `contact_id`, `tags`, `assignee_id`.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the newly created {@link SupportTicket}.
+         *
+         * @example
+         * ```typescript
+         * const client = new GptClient({ apiKey: 'sk_app_...' });
+         *
+         * const ticket = await client.support.tickets.create({
+         *   workspace_id: 'ws_abc123',
+         *   subject: 'Billing charge appears incorrect',
+         *   description: 'I was charged twice for the same subscription period.',
+         *   priority: 'high',
+         *   contact_id: 'con_jane',
+         *   tags: ['billing', 'duplicate-charge'],
+         * });
+         * console.log(ticket.id); // 'tkt_...'
+         * ```
+         */
+        create: (attributes: CreateSupportTicketAttributes, options?: RequestOptions) => Promise<SupportTicket>;
+        /**
+         * Update an existing support ticket's attributes.
+         *
+         * Commonly used to change `status` (e.g. resolve or close a ticket),
+         * update `priority`, reassign the ticket via `assignee_id`, or add/remove
+         * `tags`. Only fields present in `attributes` are changed (PATCH semantics).
+         *
+         * @param id - The unique identifier of the ticket 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 SupportTicket}.
+         *
+         * @example
+         * ```typescript
+         * const client = new GptClient({ apiKey: 'sk_app_...' });
+         *
+         * // Resolve a ticket after the issue is fixed
+         * const ticket = await client.support.tickets.update('tkt_abc123', {
+         *   status: 'resolved',
+         *   resolution_note: 'Refund processed. Credit visible within 3–5 days.',
+         * });
+         * console.log(ticket.attributes.status); // 'resolved'
+         * ```
+         */
+        update: (id: string, attributes: UpdateSupportTicketAttributes, options?: RequestOptions) => Promise<SupportTicket>;
+        /**
+         * Permanently delete a support ticket and all its messages.
+         *
+         * @param id - The unique identifier of the ticket to delete.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to `true` on successful deletion.
+         *
+         * @example
+         * ```typescript
+         * const client = new GptClient({ apiKey: 'sk_app_...' });
+         *
+         * await client.support.tickets.delete('tkt_abc123');
+         * ```
+         */
+        delete: (id: string, options?: RequestOptions) => Promise<true>;
+        /**
+         * Assign a ticket to a specific agent or queue.
+         *
+         * @param id - The unique identifier of the ticket to assign.
+         * @param attributes - Assignment attributes. Typically includes
+         *   `assigned_agent_id` and/or `queue_id`.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link SupportTicket}.
+         *
+         * @example
+         * ```typescript
+         * const ticket = await client.support.tickets.assign('tkt_abc123', {
+         *   assigned_agent_id: 'user_agent_001',
+         * });
+         * ```
+         */
+        assign: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<SupportTicket>;
+        /**
+         * Resolve a ticket, marking the issue as addressed.
+         *
+         * @param id - The unique identifier of the ticket to resolve.
+         * @param attributes - Resolution attributes. Commonly includes
+         *   `resolution_note` describing how the issue was resolved.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link SupportTicket}.
+         *
+         * @example
+         * ```typescript
+         * const ticket = await client.support.tickets.resolve('tkt_abc123', {
+         *   resolution_note: 'Refund processed successfully.',
+         * });
+         * ```
+         */
+        resolve: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<SupportTicket>;
+        /**
+         * Close a resolved ticket. Only resolved tickets can be closed.
+         *
+         * @param id - The unique identifier of the ticket to close.
+         * @param attributes - Optional close attributes.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link SupportTicket}.
+         *
+         * @example
+         * ```typescript
+         * const ticket = await client.support.tickets.close('tkt_abc123', {});
+         * ```
+         */
+        close: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<SupportTicket>;
+        /**
+         * Reopen a closed or resolved ticket.
+         *
+         * @param id - The unique identifier of the ticket to reopen.
+         * @param attributes - Optional reopen attributes.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link SupportTicket}.
+         *
+         * @example
+         * ```typescript
+         * const ticket = await client.support.tickets.reopen('tkt_abc123', {});
+         * ```
+         */
+        reopen: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<SupportTicket>;
+        /**
+         * Merge a ticket into another ticket.
+         *
+         * The merged ticket is closed and its messages are transferred to the
+         * primary ticket. Use `merge_into_ticket_id` to specify the target.
+         *
+         * @param id - The unique identifier of the ticket to merge (source).
+         * @param attributes - Merge attributes. Must include `merge_into_ticket_id`.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link SupportTicket}.
+         *
+         * @example
+         * ```typescript
+         * const ticket = await client.support.tickets.merge('tkt_dup456', {
+         *   merge_into_ticket_id: 'tkt_primary123',
+         * });
+         * ```
+         */
+        merge: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<SupportTicket>;
+        /**
+         * Add a new message to the thread of a support ticket.
+         *
+         * Messages build the conversation history on a ticket. Set
+         * `author_type` to `"agent"` for support team replies or `"customer"`
+         * for inbound customer messages. Rich-text HTML is supported via
+         * `body_html`; plain-text via `body`.
+         *
+         * @param ticketId - The ID of the ticket to add the message to.
+         * @param attributes - Key/value map of message attributes. Must include
+         *   `body` or `body_html` and `author_type` (`"agent"` | `"customer"`).
+         *   Optionally include `author_id` and `attachments`.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the newly created {@link SupportTicketMessage}.
+         *
+         * @example
+         * ```typescript
+         * const client = new GptClient({ apiKey: 'sk_app_...' });
+         *
+         * const message = await client.support.tickets.addMessage('tkt_abc123', {
+         *   body: 'Thanks for reaching out! We are looking into this now.',
+         *   author_type: 'agent',
+         *   author_id: 'user_agent_001',
+         * });
+         * console.log(message.id); // 'msg_...'
+         * ```
+         */
+        addMessage: (ticketId: string, attributes: CreateTicketMessageAttributes, options?: RequestOptions) => Promise<SupportTicketMessage>;
+        /**
+         * List all messages in the thread of a support ticket, ordered
+         * chronologically (oldest first).
+         *
+         * @param ticketId - The ID of the ticket whose messages to list.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to an array of {@link SupportTicketMessage}
+         *   records ordered by creation time ascending.
+         *
+         * @example
+         * ```typescript
+         * const client = new GptClient({ apiKey: 'sk_app_...' });
+         *
+         * const messages = await client.support.tickets.listMessages('tkt_abc123');
+         * for (const msg of messages) {
+         *   console.log(`[${msg.attributes.author_type}] ${msg.attributes.body}`);
+         * }
+         * ```
+         */
+        listMessages: (ticketId: string, options?: RequestOptions) => Promise<SupportTicketMessage[]>;
+        /**
+         * Submit a CSAT (Customer Satisfaction) rating for a resolved ticket.
+         *
+         * The rating is submitted by the end user after their issue has been
+         * resolved. Ratings use a 1–5 integer scale where 1 is "very
+         * dissatisfied" and 5 is "very satisfied". An optional `comment`
+         * field allows the customer to provide qualitative feedback.
+         *
+         * @param attributes - Key/value map of rating attributes. Must include
+         *   `ticket_id` and `rating` (integer 1–5). Optionally include
+         *   `comment` (free-text feedback from the customer).
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the created rating resource.
+         *
+         * @example
+         * ```typescript
+         * const client = new GptClient({ apiKey: 'sk_app_...' });
+         *
+         * // Customer submits a 5-star rating with a comment
+         * const rating = await client.support.tickets.rate({
+         *   ticket_id: 'tkt_abc123',
+         *   rating: 5,
+         *   comment: 'The agent resolved my issue within minutes. Excellent service!',
+         * });
+         * console.log(rating);
+         * ```
+         */
+        rate: (attributes: CreateTicketRatingAttributes, options?: RequestOptions) => Promise<SupportTicketRating>;
+    };
+    /**
+     * Tags — workspace-scoped labels for ticket categorisation.
+     *
+     * Tags are simple string labels that can be attached to tickets to
+     * facilitate filtering, routing, and reporting. For example, a workspace
+     * might define tags such as `"billing"`, `"technical"`, `"onboarding"`,
+     * or `"urgent"`. Tags are created at the workspace level and can be
+     * applied to any ticket in that workspace.
+     */
+    tags: {
+        /**
+         * List all tags defined for a workspace.
+         *
+         * @param workspaceId - The ID of the workspace whose tags to list.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to an array of {@link SupportTag} records.
+         *
+         * @example
+         * ```typescript
+         * const client = new GptClient({ apiKey: 'sk_app_...' });
+         *
+         * const tags = await client.support.tags.list('ws_abc123');
+         * console.log(tags.map((t) => t.attributes.name));
+         * // ['billing', 'technical', 'onboarding']
+         * ```
+         */
+        list: (workspaceId: string, options?: RequestOptions) => Promise<SupportTag[]>;
+        /**
+         * Create a new tag in a workspace.
+         *
+         * Tag names should be concise and consistent with your team's
+         * categorisation conventions. Once created, a tag can be referenced by
+         * name when creating or updating tickets.
+         *
+         * @param attributes - Key/value map of tag attributes. Must include
+         *   `workspace_id` and `name`.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the newly created {@link SupportTag}.
+         *
+         * @example
+         * ```typescript
+         * const client = new GptClient({ apiKey: 'sk_app_...' });
+         *
+         * const tag = await client.support.tags.create({
+         *   workspace_id: 'ws_abc123',
+         *   name: 'enterprise-account',
+         * });
+         * console.log(tag.id); // 'tag_...'
+         * ```
+         */
+        create: (attributes: CreateSupportTagAttributes, options?: RequestOptions) => Promise<SupportTag>;
+        /**
+         * Permanently delete a tag from a workspace.
+         *
+         * Deleting a tag does not automatically remove it from tickets that are
+         * already tagged with it. Clean up ticket associations before deleting a
+         * tag if consistent reporting is required.
+         *
+         * @param id - The unique identifier of the tag to delete.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to `true` on successful deletion.
+         *
+         * @example
+         * ```typescript
+         * const client = new GptClient({ apiKey: 'sk_app_...' });
+         *
+         * await client.support.tags.delete('tag_abc123');
+         * ```
+         */
+        delete: (id: string, options?: RequestOptions) => Promise<true>;
+    };
+};
+//# sourceMappingURL=support.d.ts.map

package/dist/namespaces/support.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"support.d.ts","sourceRoot":"","sources":["../../src/namespaces/support.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACV,aAAa,EACb,oBAAoB,EACpB,UAAU,EACV,mBAAmB,EACpB,MAAM,wBAAwB,CAAC;AAEhC,8DAA8D;AAC9D,MAAM,MAAM,6BAA6B,GAAG;IAC1C,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAC;IAChD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,CAAC;AAEF,sFAAsF;AACtF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAC;IAChD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,CAAC;AAEF,6DAA6D;AAC7D,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,OAAO,GAAG,UAAU,CAAC;IAClC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,OAAO,EAAE,CAAC;IACxB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,CAAC;AAEF,yDAAyD;AACzD,MAAM,MAAM,4BAA4B,GAAG;IACzC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,CAAC;AAEF,uDAAuD;AACvD,MAAM,MAAM,0BAA0B,GAAG;IACvC,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,CAAC;AAmBF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAGpD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,sBAAsB,CAAC,EAAE,EAAE,cAAc;IAErD;;;;;;;;OAQG;;QAED;;;;;;;;;;;;;;;;;;;;;;WAsBG;4BAEY,MAAM,YACT;YAAE,IAAI,CAAC,EAAE,MAAM,CAAC;YAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;SAAE,GAAG,cAAc,KAC9D,OAAO,CAAC,aAAa,EAAE,CAAC;QAW3B;;;;;;;;;;;;;;WAcG;kBAEG,MAAM,YACA,cAAc,KACvB,OAAO,CAAC,aAAa,CAAC;QAQzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA4BG;6BAEW,6BAA6B,YAC/B,cAAc,KACvB,OAAO,CAAC,aAAa,CAAC;QAYzB;;;;;;;;;;;;;;;;;;;;;;;WAuBG;qBAEG,MAAM,cACE,6BAA6B,YAC/B,cAAc,KACvB,OAAO,CAAC,aAAa,CAAC;QAazB;;;;;;;;;;;;;WAaG;qBACgB,MAAM,YAAY,cAAc,KAAG,OAAO,CAAC,IAAI,CAAC;QAQnE;;;;;;;;;;;;;;;WAeG;qBAEG,MAAM,cACE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YACzB,cAAc,KACvB,OAAO,CAAC,aAAa,CAAC;QAazB;;;;;;;;;;;;;;;WAeG;sBAEG,MAAM,cACE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YACzB,cAAc,KACvB,OAAO,CAAC,aAAa,CAAC;QAazB;;;;;;;;;;;;WAYG;oBAEG,MAAM,cACE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YACzB,cAAc,KACvB,OAAO,CAAC,aAAa,CAAC;QAazB;;;;;;;;;;;;WAYG;qBAEG,MAAM,cACE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YACzB,cAAc,KACvB,OAAO,CAAC,aAAa,CAAC;QAazB;;;;;;;;;;;;;;;;;WAiBG;oBAEG,MAAM,cACE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YACzB,cAAc,KACvB,OAAO,CAAC,aAAa,CAAC;QAazB;;;;;;;;;;;;;;;;;;;;;;;;;;WA0BG;+BAES,MAAM,cACJ,6BAA6B,YAC/B,cAAc,KACvB,OAAO,CAAC,oBAAoB,CAAC;QAehC;;;;;;;;;;;;;;;;;;WAkBG;iCAES,MAAM,YACN,cAAc,KACvB,OAAO,CAAC,oBAAoB,EAAE,CAAC;QAQlC;;;;;;;;;;;;;;;;;;;;;;;;;;WA0BG;2BAEW,4BAA4B,YAC9B,cAAc,KACvB,OAAO,CAAC,mBAAmB,CAAC;;IAajC;;;;;;;;OAQG;;QAED;;;;;;;;;;;;;;;WAeG;4BAEY,MAAM,YACT,cAAc,KACvB,OAAO,CAAC,UAAU,EAAE,CAAC;QAQxB;;;;;;;;;;;;;;;;;;;;;;WAsBG;6BAEW,0BAA0B,YAC5B,cAAc,KACvB,OAAO,CAAC,UAAU,CAAC;QAYtB;;;;;;;;;;;;;;;;;WAiBG;qBACgB,MAAM,YAAY,cAAc,KAAG,OAAO,CAAC,IAAI,CAAC;;EASxE"}