import {z} from 'zod' export type MessageDirectionEnum = 'Inbound' | 'Outbound'; export type MessageTypeEnum = 'Fax' | 'SMS' | 'VoiceMail' | 'Pager'; export type SyncTypeEnum = 'FSync' | 'ISync'; export type GetApiRestapiV10AccountAccountIdExtensionExtensionIdMessageSyncArgs = {accountId: string, extensionId: string, conversationId?: number | undefined, dateFrom?: string | undefined, dateTo?: string | undefined, direction?: Array | undefined, distinctConversations?: boolean | undefined, messageType?: Array | undefined, recordCount?: number | undefined, syncToken?: string | undefined, syncType?: SyncTypeEnum | undefined, voicemailOwner?: Array | undefined}; export type GetApiRestapiV10AccountAccountIdExtensionExtensionIdMessageSyncOptions = {baseUrl?: string | undefined, OAuth2?: string | undefined, fetch?: typeof fetch | undefined}; export const messageAttachmentTypeEnum = z.enum(["AudioRecording", "AudioTranscription", "Text", "SourceDocument", "RenderedDocument", "MmsAttachment"]); export const messageAttachmentInfo = z.object({id: z.number().int().optional(), uri: z.string().optional(), type: messageAttachmentTypeEnum.optional(), contentType: z.string().optional(), vmDuration: z.number().int().optional(), fileName: z.string().optional(), size: z.number().int().optional(), height: z.number().int().optional(), width: z.number().int().optional()}); export const messageAvailabilityEnum = z.enum(["Alive", "Deleted", "Purged"]); export const conversationInfo = z.object({id: z.string().optional(), uri: z.string().optional()}); export const messageDirectionEnum = z.enum(["Inbound", "Outbound"]); export const faxResolutionEnum = z.enum(["High", "Low"]); export const messageStoreCallerInfoResponseFrom = z.object({extensionNumber: z.string().optional(), extensionId: z.string().optional(), location: z.string().optional(), name: z.string().optional(), phoneNumber: z.string().optional()}); export const messageStatusEnum = z.enum(["Queued", "Sent", "Delivered", "DeliveryFailed", "SendingFailed", "Received"]); export const messagePriorityEnum = z.enum(["Normal", "High"]); export const messageReadStatusEnum = z.enum(["Read", "Unread"]); export const faxErrorCodeEnum = z.enum(["AllLinesInUse", "Undefined", "NoFaxSendPermission", "NoInternationalPermission", "NoFaxMachine", "NoAnswer", "LineBusy", "CallerHungUp", "NotEnoughCredits", "SentPartially", "InternationalCallingDisabled", "DestinationCountryDisabled", "UnknownCountryCode", "NotAccepted", "InvalidNumber", "CallDeclined", "TooManyCallsPerLine", "CallFailed", "RenderingFailed", "TooManyPages", "ReturnToDBQueue", "NoCallTime", "WrongNumber", "ProhibitedNumber", "InternalError", "FaxSendingProhibited", "ThePhoneIsBlacklisted", "UserNotFound", "ConvertError", "DBGeneralError", "SkypeBillingFailed", "AccountSuspended", "ProhibitedDestination", "InternationalDisabled"]); export const messageStoreCallerInfoResponseTo = z.object({extensionNumber: z.string().optional(), extensionId: z.string().optional(), location: z.string().optional(), target: z.boolean().optional(), messageStatus: messageStatusEnum.optional(), faxErrorCode: faxErrorCodeEnum.optional(), name: z.string().optional(), phoneNumber: z.string().optional(), recipientId: z.string().optional()}); export const getMessageInfoResponse = z.object({id: z.number().int().optional(), uri: z.string().optional(), extensionId: z.string().optional(), attachments: z.array(messageAttachmentInfo).optional(), availability: messageAvailabilityEnum.optional(), conversationId: z.number().int().optional(), conversation: conversationInfo.optional(), creationTime: z.string().optional(), deliveryErrorCode: z.string().optional(), direction: messageDirectionEnum.optional(), faxPageCount: z.number().int().optional(), faxResolution: faxResolutionEnum.optional(), from: messageStoreCallerInfoResponseFrom.optional(), lastModifiedTime: z.string().optional(), messageStatus: messageStatusEnum.optional(), pgToDepartment: z.boolean().optional(), priority: messagePriorityEnum.optional(), readStatus: messageReadStatusEnum.optional(), smsDeliveryTime: z.string().optional(), smsSendingAttemptsCount: z.number().int().optional(), subject: z.string().optional(), to: z.array(messageStoreCallerInfoResponseTo).optional(), type: z.enum(["Fax", "SMS", "VoiceMail", "Pager", "Text"]).optional(), vmTranscriptionStatus: z.enum(["NotAvailable", "InProgress", "TimedOut", "Completed", "CompletedPartially", "Failed", "Unknown"]).optional(), coverIndex: z.number().int().optional(), coverPageText: z.string().optional()}); export const syncTypeEnum = z.enum(["FSync", "ISync"]); export const syncInfoMessages = z.object({syncType: syncTypeEnum.optional(), syncToken: z.string().optional(), syncTime: z.string().optional(), olderRecordsExist: z.boolean().optional()}); export const getMessageSyncResponse = z.object({uri: z.string().optional(), records: z.array(getMessageInfoResponse), syncInfo: syncInfoMessages}); 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 }; /** * Sync Messages * * GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-sync */ export const getApiRestapiV10AccountAccountIdExtensionExtensionIdMessageSync = async (args: GetApiRestapiV10AccountAccountIdExtensionExtensionIdMessageSyncArgs, options?: GetApiRestapiV10AccountAccountIdExtensionExtensionIdMessageSyncOptions) => { const {baseUrl = "https://platform.ringcentral.com", fetch: fetchFn = fetch, OAuth2} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.conversationId != null) query.append("conversationId", String(args.conversationId)) if (args.dateFrom != null) query.append("dateFrom", String(args.dateFrom)) if (args.dateTo != null) query.append("dateTo", String(args.dateTo)) for (const item of args.direction ?? []) query.append("direction", String(item)) if (args.distinctConversations != null) query.append("distinctConversations", String(args.distinctConversations)) for (const item of args.messageType ?? []) query.append("messageType", String(item)) if (args.recordCount != null) query.append("recordCount", String(args.recordCount)) if (args.syncToken != null) query.append("syncToken", String(args.syncToken)) if (args.syncType != null) query.append("syncType", String(args.syncType)) for (const item of args.voicemailOwner ?? []) query.append("voicemailOwner", String(item)) if (OAuth2 !== undefined) headers.set('authorization', `Bearer ${OAuth2}`) const url = `${baseUrl.replace(/\/+$/, '')}/restapi/v1.0/account/${encodeURIComponent(String(args.accountId))}/extension/${encodeURIComponent(String(args.extensionId))}/message-sync${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(getMessageSyncResponse, await res.json()) };