import {z} from 'zod' export type GetApiV1ConversationsActivitylogArgs = {csids?: Array | undefined}; export type GetApiV1ConversationsActivitylogOptions = {baseUrl: string, ApiKeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const stringId = z.string(); export const timestamp = z.string(); export const activityType = z.enum(["tag_added", "tag_removed", "conversation_created_by_customer", "conversation_created_by_agent", "conversation_closed", "conversation_pending", "conversation_reopened", "note_added", "message_added_by_customer", "message_added_by_agent", "conversation_assigned", "conversation_offered", "conversation_offer_rejected", "conversation_offer_timeout", "conversation_offer_accepted", "transfer_initiated", "transfer_failed", "transfer_successful", "conversation_language_updated", "followup_added", "followup_removed", "followup_expired", "conversation_autoreply_sent", "conversation_rating_scheduled", "conversation_rating_unscheduled", "conversation_rating_cancelled", "conversation_rated", "conversation_claimed", "conversation_unassigned"]); export const emailString = z.string(); export const phoneNumberString = z.string(); export const activityLogUser = z.object({id: stringId, name: z.string().optional(), email: emailString.optional(), phone_number: phoneNumberString.optional()}); export const tagAddedAttribute = z.object({tag_name: z.string()}); export const tagRemovedAttribute = z.object({tag_name: z.string()}); export const conversationOfferedAttribute = z.object({agent_names: z.array(z.string())}); export const noteAddedAttribute = z.object({note: z.string(), avatar_url: z.string().optional()}); export const messageAddedAttribute = z.object({message_id: stringId, from_endpoint: z.string().optional(), avatar_url: z.string().optional()}); export const conversationAssignedAttribute = z.object({agent_id: stringId, agent_name: z.string().optional()}); export const conversationTransferredAttribute = z.object({transfer_type: z.string(), destination_type: z.string(), destination_id: stringId, destination_label: z.string().optional(), reason: z.string().optional()}); export const conversationLanguageUpdatedAttribute = z.object({language: z.string()}); export const conversationAutoReplySentAttribute = z.object({template_name: z.string()}); export const conversationRatingScheduledAttribute = z.object({rating_scheduled_time: timestamp}); export const conversationRatingOfferedAttribute = z.object({agent: activityLogUser, user: activityLogUser}); export const conversationRatedAttribute = z.object({agent: activityLogUser, rating_score: z.number().int().optional(), rating_message: z.string().optional()}); export const conversationClaimedAttribute = z.object({claimed_from_label: z.string().optional(), claimed_from_type: z.string().optional()}); export const conversationCreatedAttribute = z.object({conversation_subject: z.string().optional()}); export const conversationUnassignedAttribute = z.object({agent: activityLogUser}); export const activityLog = z.object({id: stringId, conversation_id: z.number().int(), activity_timestmap: timestamp.optional(), activity_type: activityType, author: activityLogUser.optional(), attributes: z.union([tagAddedAttribute, tagRemovedAttribute, conversationOfferedAttribute, noteAddedAttribute, messageAddedAttribute, conversationAssignedAttribute, conversationTransferredAttribute, conversationLanguageUpdatedAttribute, conversationAutoReplySentAttribute, conversationRatingScheduledAttribute, conversationRatingOfferedAttribute, conversationRatedAttribute, conversationClaimedAttribute, conversationCreatedAttribute, conversationUnassignedAttribute]).optional()}); export const paging = z.object({cursors: z.object({after: z.string().optional(), before: z.string().optional()}), next_page: z.string().optional(), prev_page: z.string().optional()}); export const getApiV1ConversationsActivitylogResponse = z.object({data: z.array(activityLog), paging: paging.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 }; /** * Get a list of activitylog events * * GET /v1/conversations/activitylog * * Also accepts auth: BearerAuth */ export const getApiV1ConversationsActivitylog = async (args: GetApiV1ConversationsActivitylogArgs, options: GetApiV1ConversationsActivitylogOptions) => { const {baseUrl, fetch: fetchFn = fetch, ApiKeyAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.csids != null) query.append("csids", args.csids.join(',')) if (ApiKeyAuth !== undefined) headers.set("Authorization", ApiKeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/v1/conversations/activitylog${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(getApiV1ConversationsActivitylogResponse, await res.json()) };