import {z} from 'zod' export type GetApiApiTicketsArgs = {order_by?: ('created_datetime:asc' | 'created_datetime:desc' | 'updated_datetime:asc' | 'updated_datetime:desc') | undefined, cursor?: string | undefined, customer_id?: number | undefined, trashed?: boolean | undefined, external_id?: string | undefined, limit?: number | undefined, view_id?: number | undefined, rule_id?: number | undefined, ticket_ids?: Array | undefined}; export type GetApiApiTicketsOptions = {baseUrl?: string | undefined, basicAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const ticketStatus = z.enum(["open", "closed"]); export const ticketPriority = z.enum(["critical", "high", "normal", "low"]); export const legacyChannelSlug = z.enum(["aircall", "api", "chat", "contact_form", "email", "facebook", "facebook-mention", "facebook-messenger", "facebook-recommendations", "help-center", "instagram-ad-comment", "instagram-comment", "instagram-direct-message", "instagram-mention", "internal-note", "phone", "sms", "twitter", "twitter-direct-message", "whatsapp", "yotpo-review"]); export const ticketVia = z.enum(["aircall", "api", "chat", "contact_form", "email", "facebook", "facebook-mention", "facebook-messenger", "facebook-recommendations", "form", "gorgias_chat", "help-center", "helpdesk", "instagram", "instagram-ad-comment", "instagram-comment", "instagram-direct-message", "instagram-mention", "internal-note", "offline_capture", "phone", "rule", "self_service", "shopify", "sms", "twilio", "twitter", "twitter-direct-message", "whatsapp", "yotpo", "yotpo-review", "zendesk"]); export const ticketCompactCustomer = z.object({id: z.number().int(), email: z.string(), name: z.string(), firstname: z.string(), lastname: z.string(), meta: z.unknown()}); export const ticketUser = z.object({id: z.number().int(), email: z.string(), name: z.string(), firstname: z.string(), lastname: z.string(), meta: z.unknown(), bio: z.string()}); export const ticketTeam = z.object({id: z.number().int(), name: z.string(), decoration: z.object({})}); export const ticketSummary = z.object({content: z.string(), created_datetime: z.string(), updated_datetime: z.string(), triggered_by: z.number().int()}); export const integrationType = z.enum(["aircall", "alloy", "app", "bigcommerce", "ecom", "email", "facebook", "gmail", "gorgias_chat", "http", "klaviyo", "magento2", "outlook", "phone", "recharge", "self_service", "shopify", "smile", "smooch", "smooch_inside", "sms", "twitter", "whatsapp", "yotpo", "zendesk"]); export const ticketCompactIntegration = z.object({name: z.string(), address: z.string(), type: integrationType}); export const ticketMeta = z.unknown(); export const ticketTagDecoration = z.object({color: z.string().optional()}); export const ticketTag = z.object({id: z.number().int(), name: z.string(), decoration: ticketTagDecoration}); export const eventObjectType = z.enum(["Account", "AccountSetting", "Customer", "CustomField", "CustomFieldCondition", "CustomUserAvailabilityStatus", "CustomerExternalData", "Integration", "Macro", "Order", "Role", "Rule", "SatisfactionSurvey", "Shopper", "ShopperAddress", "Subscription", "Tag", "Team", "TicketMessage", "Ticket", "User", "UserSetting", "View", "Widget"]); export const requirementType = z.enum(["visible", "required", "conditional"]); export const managedTicketFieldType = z.enum(["contact_reason", "product", "resolution", "ai_intent", "ai_outcome", "ai_sales", "ai_discount", "ai_journey", "managed_sentiment", "call_status"]); export const inputSettingsNumber = z.object({input_type: z.literal("input_number"), placeholder: z.string().optional(), min: z.union([z.number(), z.string()]).optional(), max: z.union([z.number(), z.string()]).optional()}); export const definitionNumber = z.object({data_type: z.literal("number"), input_settings: inputSettingsNumber}); export const inputSettingsText = z.object({input_type: z.literal("input"), placeholder: z.string().optional()}); export const inputSettingsDropdownStr = z.object({input_type: z.literal("dropdown"), choices: z.array(z.string()), default: z.string().optional()}); export const definitionText = z.object({data_type: z.literal("text"), input_settings: z.discriminatedUnion("input_type", [inputSettingsText, inputSettingsDropdownStr])}); export const inputSettingsDropdownBool = z.object({input_type: z.literal("dropdown"), choices: z.array(z.boolean()), default: z.boolean().optional()}); export const definitionBoolean = z.object({data_type: z.literal("boolean"), input_settings: inputSettingsDropdownBool}); export const ticketCustomField = z.object({id: z.number().int().gt(0), external_id: z.string().optional(), object_type: eventObjectType, label: z.string(), description: z.string().optional(), priority: z.number().int(), required: z.boolean(), requirement_type: requirementType, managed_type: managedTicketFieldType.optional(), definition: z.discriminatedUnion("data_type", [definitionNumber, definitionText, definitionBoolean]), created_datetime: z.string(), updated_datetime: z.string().optional(), deactivated_datetime: z.string().optional()}); export const ticketCustomFieldValue = z.object({field: ticketCustomField.optional(), id: z.number().int().optional(), prediction: z.unknown(), value: z.unknown()}); export const ticketCompact = z.object({id: z.number().int(), uri: z.string(), external_id: z.string(), language: z.string(), status: ticketStatus.optional(), priority: ticketPriority.optional(), channel: z.union([legacyChannelSlug, z.string()]), via: ticketVia, from_agent: z.boolean(), customer: ticketCompactCustomer, assignee_user: ticketUser, assignee_team: ticketTeam, subject: z.string(), summary: ticketSummary.optional(), excerpt: z.string(), integrations: z.array(ticketCompactIntegration), meta: ticketMeta, tags: z.array(ticketTag), messages_count: z.number().int(), is_unread: z.boolean(), spam: z.boolean(), created_datetime: z.string(), opened_datetime: z.string(), last_received_message_datetime: z.string(), last_message_datetime: z.string(), last_sent_message_not_delivered: z.boolean(), updated_datetime: z.string(), closed_datetime: z.string(), snooze_datetime: z.string(), trashed_datetime: z.string(), custom_fields: z.record(z.string(), ticketCustomFieldValue).optional()}); export const cursorPaginationMeta = z.object({prev_cursor: z.string(), next_cursor: z.string(), total_resources: z.number().int()}); export const getApiApiTicketsResponse = z.object({object: z.string(), uri: z.string(), data: z.array(ticketCompact), meta: cursorPaginationMeta}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * List tickets * * GET /api/tickets */ export const getApiApiTickets = async (args: GetApiApiTicketsArgs, options?: GetApiApiTicketsOptions) => { const {baseUrl = "https://your-domain.gorgias.com", fetch: fetchFn = fetch, basicAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.order_by != null) query.append("order_by", String(args.order_by)) if (args.cursor != null) query.append("cursor", String(args.cursor)) if (args.customer_id != null) query.append("customer_id", String(args.customer_id)) if (args.trashed != null) query.append("trashed", String(args.trashed)) if (args.external_id != null) query.append("external_id", String(args.external_id)) if (args.limit != null) query.append("limit", String(args.limit)) if (args.view_id != null) query.append("view_id", String(args.view_id)) if (args.rule_id != null) query.append("rule_id", String(args.rule_id)) for (const item of args.ticket_ids ?? []) query.append("ticket_ids", String(item)) if (basicAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${basicAuth.username}:${basicAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/api/tickets${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(getApiApiTicketsResponse, await res.json()) };