import {z} from 'zod' export type CollaboratorObject = {email?: string | undefined, name?: string | undefined}; export type AttachmentBaseObject = {content_type?: string | undefined, content_url?: string | undefined, deleted?: boolean | undefined, file_name?: string | undefined, height?: number | undefined, id?: number | undefined, inline?: boolean | undefined, malware_access_override?: boolean | undefined, malware_scan_result?: string | undefined, mapped_content_url?: string | undefined, size?: number | undefined, url?: string | undefined, width?: number | undefined}; export type AttachmentObject = {content_type?: string | undefined, content_url?: string | undefined, deleted?: boolean | undefined, file_name?: string | undefined, height?: number | undefined, id?: number | undefined, inline?: boolean | undefined, malware_access_override?: boolean | undefined, malware_scan_result?: string | undefined, mapped_content_url?: string | undefined, size?: number | undefined, url?: string | undefined, width?: number | undefined, thumbnails?: Array | undefined}; export type TicketAuditViaObject = {channel?: string | undefined, source?: {[key: string]: unknown} | undefined}; export type TicketCommentObject = {attachments?: Array | undefined, audit_id?: number | undefined, author_id?: number | undefined, body?: string | undefined, created_at?: string | undefined, html_body?: string | undefined, id?: number | undefined, metadata?: {[key: string]: unknown} | undefined, plain_body?: string | undefined, public?: boolean | undefined, type?: string | undefined, uploads?: Array | undefined, via?: TicketAuditViaObject | undefined}; export type EmailCCObject = {action?: ('put' | 'delete') | undefined, user_email?: string | undefined, user_id?: string | undefined, user_name?: string | undefined}; export type FollowerObject = {action?: ('put' | 'delete') | undefined, user_email?: string | undefined, user_id?: string | undefined}; export type TicketUpdateInput = {additional_collaborators?: Array | undefined, assignee_email?: string | undefined, assignee_id?: number | undefined, attribute_value_ids?: Array | undefined, collaborator_ids?: Array | undefined, comment?: TicketCommentObject | undefined, custom_fields?: (Array<{id?: number | undefined, value?: (string | number | boolean | Array | number) | undefined}>) | undefined, custom_status_id?: number | undefined, due_at?: (string | null) | undefined, email_ccs?: Array | undefined, external_id?: string | undefined, followers?: Array | undefined, group_id?: number | undefined, organization_id?: number | undefined, priority?: ('urgent' | 'high' | 'normal' | 'low') | undefined, problem_id?: number | undefined, requester_id?: number | undefined, safe_update?: boolean | undefined, sharing_agreement_ids?: Array | undefined, status?: ('new' | 'open' | 'pending' | 'hold' | 'solved' | 'closed') | undefined, subject?: string | undefined, tags?: Array | undefined, type?: ('problem' | 'incident' | 'question' | 'task') | undefined, updated_stamp?: string | undefined}; export type TicketUpdateRequest = {ticket?: TicketUpdateInput | undefined}; export type UpdateApiApiV2TicketsTicketIdArgs = {ticket_id: number, body: TicketUpdateRequest}; export type UpdateApiApiV2TicketsTicketIdOptions = {baseUrl?: string | undefined, apiTokenAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const viaObject = z.object({channel: z.string().optional(), source: z.object({from: z.object({address: z.string().nullable().optional(), id: z.number().int().nullable().optional(), name: z.string().nullable().optional(), title: z.string().nullable().optional()}).optional(), rel: z.string().nullable().optional(), to: z.object({address: z.string().optional(), name: z.string().optional()}).optional()}).and(z.record(z.string(), z.unknown())).optional()}); export const attachmentBaseObject = z.object({content_type: z.string().optional(), content_url: z.string().optional(), deleted: z.boolean().optional(), file_name: z.string().optional(), height: z.number().int().optional(), id: z.number().int().optional(), inline: z.boolean().optional(), malware_access_override: z.boolean().optional(), malware_scan_result: z.string().optional(), mapped_content_url: z.string().optional(), size: z.number().int().optional(), url: z.string().optional(), width: z.number().int().optional()}); export const attachmentObject = z.object({content_type: z.string().optional(), content_url: z.string().optional(), deleted: z.boolean().optional(), file_name: z.string().optional(), height: z.number().int().optional(), id: z.number().int().optional(), inline: z.boolean().optional(), malware_access_override: z.boolean().optional(), malware_scan_result: z.string().optional(), mapped_content_url: z.string().optional(), size: z.number().int().optional(), url: z.string().optional(), width: z.number().int().optional(), thumbnails: z.array(attachmentBaseObject).optional()}); export const attributeValueObject = z.object({id: z.string().optional(), name: z.string().optional(), attribute_id: z.string().optional()}); export const auditEvent = z.discriminatedUnion("type", [z.object({id: z.number().int(), type: z.literal("Create"), via: viaObject.optional(), field_name: z.string().optional(), value: z.union([z.string(), z.array(z.unknown()), z.object({})]).optional()}), z.object({id: z.number().int(), type: z.literal("Change"), via: viaObject.optional(), field_name: z.string().optional(), value: z.union([z.string(), z.array(z.unknown()), z.object({})]).optional(), previous_value: z.union([z.string(), z.array(z.unknown()), z.object({})]).optional()}), z.object({id: z.number().int(), type: z.literal("Comment"), via: viaObject.optional(), body: z.string().optional(), html_body: z.string().optional(), public: z.boolean().optional(), trusted: z.boolean().optional(), author_id: z.number().int().optional(), attachments: z.array(attachmentObject).optional()}), z.object({id: z.number().int(), type: z.literal("CommentRedactionEvent"), via: viaObject.optional(), comment_id: z.number().int().optional()}), z.object({id: z.number().int(), type: z.literal("AttachmentRedactionEvent"), via: viaObject.optional(), attachment_id: z.number().int().optional(), comment_id: z.number().int().optional()}), z.object({id: z.number().int(), type: z.literal("VoiceComment"), via: viaObject.optional(), data: z.object({}).optional(), formatted_from: z.string().optional(), formatted_to: z.string().optional(), body: z.string().optional(), html_body: z.string().optional(), public: z.boolean().optional(), trusted: z.boolean().optional(), author_id: z.number().int().optional(), transcription_visible: z.boolean().optional(), attachments: z.array(attachmentObject).optional()}), z.object({id: z.number().int(), type: z.literal("CommentPrivacyChange"), via: viaObject.optional(), comment_id: z.number().int().optional(), public: z.boolean().optional()}), z.object({id: z.number().int(), type: z.literal("SuspendedTicketRecovery"), via: viaObject.optional(), cause: z.string().optional(), cause_name: z.string().optional(), cause_id: z.number().int().optional(), recovery_details: z.string().optional(), recovery_type: z.enum(["manual", "automatic"]).optional(), recovered_at: z.string().optional(), recovered_by: z.number().int().optional()}), z.object({id: z.number().int(), type: z.literal("Notification"), via: viaObject.optional(), subject: z.string().optional(), body: z.string().optional(), recipients: z.array(z.number().int()).optional()}), z.object({id: z.number().int(), type: z.literal("NotificationWithCcs"), via: viaObject.optional(), subject: z.string().optional(), body: z.string().optional(), recipients: z.array(z.number().int()).optional()}), z.object({id: z.number().int(), type: z.literal("SmsNotification"), via: viaObject.optional(), body: z.string().optional(), recipients: z.array(z.number().int()).optional()}), z.object({id: z.number().int(), type: z.literal("Cc"), via: viaObject.optional(), body: z.string().optional(), recipients: z.array(z.number().int()).optional()}), z.object({id: z.number().int(), type: z.literal("FollowerNotificationEvent"), via: viaObject.optional(), subject: z.string().optional(), body: z.string().optional(), recipients: z.array(z.number().int()).optional()}), z.object({id: z.number().int(), type: z.literal("FollowersChange"), via: viaObject.optional(), previous_followers: z.array(z.number().int()).optional(), current_followers: z.array(z.number().int()).optional()}), z.object({id: z.number().int(), type: z.literal("EmailCcChange"), via: viaObject.optional(), previous_email_ccs: z.array(z.string()).optional(), current_email_ccs: z.array(z.string()).optional()}), z.object({id: z.number().int(), type: z.literal("MacroReference"), via: viaObject.optional(), macro_id: z.number().int().optional(), macro_title: z.string().optional(), macro_deleted: z.boolean().optional()}), z.object({id: z.number().int(), type: z.literal("SatisfactionRating"), via: viaObject.optional(), score: z.enum(["offered", "unoffered", "good", "bad"]).optional(), assignee_id: z.number().int().optional(), body: z.string().optional()}), z.object({id: z.number().int(), type: z.literal("TicketSharingEvent"), via: viaObject.optional(), agreement_id: z.number().int().optional(), action: z.enum(["shared", "unshared"]).optional()}), z.object({id: z.number().int(), type: z.literal("OrganizationActivity"), via: viaObject.optional(), subject: z.string().optional(), body: z.string().optional(), recipients: z.array(z.number().int()).optional()}), z.object({id: z.number().int(), type: z.literal("Error"), via: viaObject.optional(), message: z.string().optional()}), z.object({id: z.number().int(), type: z.literal("Tweet"), via: viaObject.optional(), direct_message: z.boolean().optional(), body: z.string().optional(), recipients: z.array(z.number().int()).optional()}), z.object({id: z.number().int(), type: z.literal("FacebookEvent"), via: viaObject.optional(), page: z.object({}).optional(), communication: z.number().int().optional(), ticket_via: z.enum(["post", "message"]).optional(), body: z.string().optional()}), z.object({id: z.number().int(), type: z.literal("FacebookComment"), via: viaObject.optional(), data: z.object({}).optional(), body: z.string().optional(), html_body: z.string().optional(), public: z.boolean().optional(), trusted: z.boolean().optional(), author_id: z.number().int().optional(), graph_object_id: z.string().optional()}), z.object({id: z.number().int(), type: z.literal("External"), via: viaObject.optional(), resource: z.string().optional(), body: z.string().optional()}), z.object({id: z.number().int(), type: z.literal("LogMeInTranscript"), via: viaObject.optional(), body: z.string().optional()}), z.object({id: z.number().int(), type: z.literal("Push"), via: viaObject.optional(), value: z.string().optional(), value_reference: z.string().optional()}), z.object({id: z.number().int(), type: z.literal("ChatStartedEvent"), via: viaObject.optional(), value: z.array(z.unknown()).optional(), history: z.array(z.unknown()).optional(), webpath: z.array(z.unknown()).optional(), attachments: z.array(attachmentObject).optional()}), z.object({id: z.number().int(), type: z.literal("ChatEndedEvent"), via: viaObject.optional(), value: z.array(z.unknown()).optional(), attachments: z.array(attachmentObject).optional()}), z.object({id: z.number().int(), type: z.literal("AssociateAttValsEvent"), via: viaObject.optional(), attribute_values: z.array(attributeValueObject).optional()}), z.object({id: z.number().int(), type: z.literal("SurveyOffered"), via: viaObject.optional(), assigned_user_id: z.number().int().nullable().optional(), assigned_group_id: z.number().int().nullable().optional(), survey_id: z.string().optional(), survey_type: z.string().optional()}), z.object({id: z.number().int(), type: z.literal("SurveyResponseSubmitted"), via: viaObject.optional(), assigned_user_id: z.number().int().nullable().optional(), assigned_group_id: z.number().int().nullable().optional(), survey_response_id: z.string().optional(), survey_type: z.string().optional()}), z.object({id: z.number().int(), type: z.literal("OfferedToEvent"), via: viaObject.optional(), assignee: z.number().int().optional(), skills: z.array(attributeValueObject).optional()}), z.object({id: z.number().int(), type: z.literal("RoutingChannelEvent"), via: viaObject.optional(), previous: z.string().optional(), current: z.string().optional()}), z.object({id: z.number().int(), type: z.literal("WebhookEvent"), via: z.object({channel: z.string().optional(), source: z.object({from: z.object({address: z.string().nullable().optional(), id: z.number().int().nullable().optional(), name: z.string().nullable().optional(), title: z.string().nullable().optional(), deleted: z.boolean().optional()}).optional(), rel: z.string().nullable().optional(), to: z.object({address: z.string().optional(), name: z.string().optional()}).optional()}).and(z.record(z.string(), z.unknown())).optional()}).optional()})]); export const auditObject = z.object({author_id: z.number().int().optional(), created_at: z.string().optional(), events: z.array(auditEvent).optional(), id: z.number().int().optional(), metadata: z.object({}).optional(), ticket_id: z.number().int().optional(), via: viaObject.optional()}); export const collaboratorObject = z.object({email: z.string().optional(), name: z.string().optional()}); export const ticketObject = z.object({allow_attachments: z.boolean().optional(), allow_channelback: z.boolean().optional(), assignee_email: z.string().optional(), assignee_id: z.number().int().optional(), attribute_value_ids: z.array(z.number().int()).optional(), brand_id: z.number().int().optional(), collaborator_ids: z.array(z.number().int()).optional(), collaborators: z.array(collaboratorObject).optional(), comment: z.object({}).optional(), created_at: z.string().optional(), custom_fields: z.array(z.object({id: z.number().int().optional(), value: z.union([z.string(), z.number().int(), z.boolean(), z.array(z.string()), z.number()]).nullable().optional()})).optional(), custom_status_id: z.number().int().optional(), description: z.string().optional(), due_at: z.string().nullable().optional(), email_cc_ids: z.array(z.number().int()).optional(), email_ccs: z.object({}).optional(), external_id: z.string().optional(), follower_ids: z.array(z.number().int()).optional(), followers: z.object({}).optional(), followup_ids: z.array(z.number().int()).optional(), forum_topic_id: z.number().int().optional(), from_messaging_channel: z.boolean().optional(), generated_timestamp: z.number().int().optional(), group_id: z.number().int().optional(), has_incidents: z.boolean().optional(), id: z.number().int().optional(), is_public: z.boolean().optional(), macro_id: z.number().int().optional(), macro_ids: z.array(z.number().int()).optional(), metadata: z.object({}).optional(), organization_id: z.number().int().optional(), priority: z.enum(["urgent", "high", "normal", "low"]).optional(), problem_id: z.number().int().optional(), raw_subject: z.string().optional(), recipient: z.string().optional(), requester: z.object({}).optional(), requester_id: z.number().int(), safe_update: z.boolean().optional(), satisfaction_rating: z.record(z.string(), z.unknown()).optional(), sharing_agreement_ids: z.array(z.number().int()).optional(), status: z.enum(["new", "open", "pending", "hold", "solved", "closed"]).optional(), subject: z.string().optional(), submitter_id: z.number().int().optional(), tags: z.array(z.string()).optional(), ticket_form_id: z.number().int().optional(), type: z.enum(["problem", "incident", "question", "task"]).optional(), updated_at: z.string().optional(), updated_stamp: z.string().optional(), url: z.string().optional(), via: z.object({channel: z.string().optional(), source: z.record(z.string(), z.unknown()).optional()}).optional(), via_followup_source_id: z.number().int().optional(), via_id: z.number().int().optional(), voice_comment: z.object({}).optional()}); export const ticketUpdateResponse = z.object({audit: auditObject.optional(), ticket: ticketObject.optional()}); 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 }; /** * Update Ticket * * PUT /api/v2/tickets/{ticket_id} */ export const updateApiApiV2TicketsTicketId = async (args: UpdateApiApiV2TicketsTicketIdArgs, options?: UpdateApiApiV2TicketsTicketIdOptions) => { const {baseUrl = "https://example.zendesk.com", fetch: fetchFn = fetch, apiTokenAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (apiTokenAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${apiTokenAuth.username}:${apiTokenAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/api/v2/tickets/${encodeURIComponent(String(args.ticket_id))}${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "PUT", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(ticketUpdateResponse, await res.json()) };