import {z} from 'zod' export type GetApiRestapiV10AccountAccountIdExtensionExtensionIdAnsweringRuleArgs = {accountId: string, extensionId: string, type?: 'Custom' | undefined, view?: ('Detailed' | 'Simple') | undefined, enabledOnly?: boolean | undefined, page?: number | undefined, perPage?: number | undefined}; export type GetApiRestapiV10AccountAccountIdExtensionExtensionIdAnsweringRuleOptions = {baseUrl?: string | undefined, OAuth2?: string | undefined, fetch?: typeof fetch | undefined}; export const timeInterval = z.object({from: z.string().optional(), to: z.string().optional()}); export const weeklyScheduleInfo = z.object({monday: z.array(timeInterval).optional(), tuesday: z.array(timeInterval).optional(), wednesday: z.array(timeInterval).optional(), thursday: z.array(timeInterval).optional(), friday: z.array(timeInterval).optional(), saturday: z.array(timeInterval).optional(), sunday: z.array(timeInterval).optional()}); export const rangesInfo = z.object({from: z.string().optional(), to: z.string().optional()}); export const scheduleInfo = z.object({weeklyRanges: weeklyScheduleInfo.optional(), ranges: z.array(rangesInfo).optional(), ref: z.enum(["BusinessHours", "AfterHours"]).optional()}); export const calledNumberInfo = z.object({phoneNumber: z.string().optional()}); export const callersInfo = z.object({callerId: z.string().optional(), name: z.string().optional()}); export const createAnsweringRuleForwardingNumberInfo = z.object({id: z.string().optional(), uri: z.string().optional(), phoneNumber: z.string().optional(), label: z.string().optional(), type: z.enum(["Home", "Mobile", "Work", "PhoneLine", "Outage", "Other", "BusinessMobilePhone", "ExternalCarrier", "ExtensionApps"]).optional()}); export const forwardingRuleInfo = z.object({index: z.number().int().optional(), ringCount: z.number().int().optional(), enabled: z.boolean().optional(), forwardingNumbers: z.array(createAnsweringRuleForwardingNumberInfo).optional()}); export const forwardingInfo = z.object({notifyMySoftPhones: z.boolean().optional(), notifyAdminSoftPhones: z.boolean().optional(), softPhonesRingCount: z.number().int().optional(), softPhonesAlwaysRing: z.boolean().optional(), ringingMode: z.enum(["Sequentially", "Simultaneously"]).optional(), rules: z.array(forwardingRuleInfo).optional(), softPhonesPositionTop: z.boolean().optional(), mobileTimeout: z.boolean().optional()}); export const unconditionalForwardingInfo = z.object({phoneNumber: z.string().optional(), action: z.enum(["HoldTimeExpiration", "MaxCallers", "NoAnswer"]).optional()}); export const transferExtensionInfo = z.object({id: z.string().optional(), uri: z.string().optional(), name: z.string().optional(), extensionNumber: z.string().optional()}); export const transferInfo = z.object({extension: transferExtensionInfo.optional(), action: z.enum(["HoldTimeExpiration", "MaxCallers", "NoAnswer"]).optional()}); export const fixedOrderAgentsExtensionInfo = z.object({id: z.string().optional(), uri: z.string().optional(), extensionNumber: z.string().optional(), name: z.string().optional()}); export const fixedOrderAgents = z.object({extension: fixedOrderAgentsExtensionInfo.optional(), index: z.number().int().optional()}); export const queueInfo = z.object({transferMode: z.enum(["Rotating", "Simultaneous", "FixedOrder"]).optional(), transfer: z.array(transferInfo).optional(), noAnswerAction: z.enum(["WaitPrimaryMembers", "WaitPrimaryAndOverflowMembers", "Voicemail", "TransferToExtension", "UnconditionalForwarding"]).optional(), fixedOrderAgents: z.array(fixedOrderAgents).optional(), holdAudioInterruptionMode: z.enum(["Never", "WhenMusicEnds", "Periodically"]).optional(), holdAudioInterruptionPeriod: z.number().int().optional(), holdTimeExpirationAction: z.enum(["TransferToExtension", "UnconditionalForwarding", "Voicemail"]).optional(), agentTimeout: z.number().int().optional(), wrapUpTime: z.number().int().gte(0).lte(300).optional(), holdTime: z.number().int().optional(), maxCallers: z.number().int().lte(25).optional(), maxCallersAction: z.enum(["Voicemail", "Announcement", "TransferToExtension", "UnconditionalForwarding"]).optional(), unconditionalForwarding: z.array(unconditionalForwardingInfo).optional()}); export const transferredExtension = z.object({id: z.string().optional(), uri: z.string().optional()}); export const transferredExtensionInfo = z.object({extension: transferredExtension.optional()}); export const recipientInfo = z.object({uri: z.string().optional(), id: z.string().optional()}); export const voicemailInfo = z.object({enabled: z.boolean().optional(), recipient: recipientInfo.optional()}); export const greetingTypeEnum = z.enum(["Introductory", "Announcement", "AutomaticRecording", "BlockedCallersAll", "BlockedCallersSpecific", "BlockedNoCallerId", "BlockedPayPhones", "ConnectingMessage", "ConnectingAudio", "StartRecording", "StopRecording", "Voicemail", "Unavailable", "InterruptPrompt", "HoldMusic", "Company"]); export const presetInfo = z.object({uri: z.string().optional(), id: z.string().optional(), name: z.string().optional()}); export const customGreetingInfoRequest = z.object({id: z.string().optional()}); export const greetingInfo = z.object({type: greetingTypeEnum.optional(), preset: presetInfo.optional(), custom: customGreetingInfoRequest.optional()}); export const sharedLinesInfo = z.object({timeout: z.number().int().gte(10).lte(80).optional()}); export const missedCallExtensionInfoExternalNumber = z.object({phoneNumber: z.string().optional()}); export const missedCallExtensionInfo = z.object({id: z.string().optional(), externalNumber: missedCallExtensionInfoExternalNumber.optional()}); export const missedCallInfo = z.object({actionType: z.enum(["PlayGreetingAndDisconnect", "ConnectToExtension", "ConnectToExternalNumber"]).optional(), extension: missedCallExtensionInfo.optional()}); export const answeringRuleInfo = z.object({uri: z.string().optional(), id: z.string().optional(), type: z.enum(["BusinessHours", "AfterHours", "Custom"]).optional(), name: z.string().optional(), enabled: z.boolean().optional(), schedule: scheduleInfo.optional(), calledNumbers: z.array(calledNumberInfo).optional(), callers: z.array(callersInfo).optional(), callHandlingAction: z.enum(["ForwardCalls", "UnconditionalForwarding", "AgentQueue", "TransferToExtension", "TakeMessagesOnly", "PlayAnnouncementOnly", "SharedLines"]).optional(), forwarding: forwardingInfo.optional(), unconditionalForwarding: unconditionalForwardingInfo.optional(), queue: queueInfo.optional(), transfer: transferredExtensionInfo.optional(), voicemail: voicemailInfo.optional(), greetings: z.array(greetingInfo).optional(), screening: z.enum(["Off", "NoCallerId", "UnknownCallerId", "Always"]).optional(), sharedLines: sharedLinesInfo.optional(), missedCall: missedCallInfo.optional()}); export const enumeratedPagingModel = z.object({perPage: z.number().int().gte(1).lte(1000), page: z.number().int().gte(1).lte(1000).optional(), pageStart: z.number().int().gte(0).optional(), pageEnd: z.number().int().gte(0).optional(), totalPages: z.number().int().gte(0).optional(), totalElements: z.number().int().gte(0).optional()}); export const pageNavigationUri = z.object({uri: z.string().optional()}); export const pageNavigationModel = z.object({firstPage: pageNavigationUri.optional(), nextPage: pageNavigationUri.optional(), previousPage: pageNavigationUri.optional(), lastPage: pageNavigationUri.optional()}); export const userAnsweringRuleList = z.object({uri: z.string().optional(), records: z.array(answeringRuleInfo).optional(), paging: enumeratedPagingModel.optional(), navigation: pageNavigationModel.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 }; /** * List Call Handling Rules * * GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule */ export const getApiRestapiV10AccountAccountIdExtensionExtensionIdAnsweringRule = async (args: GetApiRestapiV10AccountAccountIdExtensionExtensionIdAnsweringRuleArgs, options?: GetApiRestapiV10AccountAccountIdExtensionExtensionIdAnsweringRuleOptions) => { 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.type != null) query.append("type", String(args.type)) if (args.view != null) query.append("view", String(args.view)) if (args.enabledOnly != null) query.append("enabledOnly", String(args.enabledOnly)) if (args.page != null) query.append("page", String(args.page)) if (args.perPage != null) query.append("perPage", String(args.perPage)) 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))}/answering-rule${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(userAnsweringRuleList, await res.json()) };