import {z} from 'zod' export type SearchDirectoryExtensionType = 'User' | 'Department' | 'Announcement' | 'Voicemail' | 'DigitalUser' | 'VirtualUser' | 'FaxUser' | 'PagingOnly' | 'SharedLinesGroup' | 'IvrMenu' | 'ApplicationExtension' | 'ParkLocation' | 'Limited' | 'Bot' | 'Site' | 'Room' | 'ProxyAdmin' | 'DelegatedLinesGroup' | 'FlexibleUser' | 'GroupCallPickup' | 'RoomConnector'; export type SearchDirectoryContactType = 'User' | 'Department' | 'Announcement' | 'Voicemail' | 'SharedLinesGroup' | 'PagingOnly' | 'ParkLocation' | 'IvrMenu' | 'Limited' | 'ApplicationExtension' | 'Site' | 'Bot' | 'Room' | 'DelegatedLinesGroup' | 'GroupCallPickup' | 'External'; export type SearchDirectoryExtensionTypes = Array; export type OrderBy = {index?: number | undefined, fieldName?: ('firstName' | 'lastName' | 'extensionNumber' | 'phoneNumber' | 'email' | 'jobTitle' | 'department') | undefined, direction?: ('Asc' | 'Desc') | undefined}; export type SearchDirectoryEntriesRequest = {searchString?: string | undefined, searchFields?: (Array<'firstName' | 'lastName' | 'extensionNumber' | 'phoneNumber' | 'email' | 'jobTitle' | 'department' | 'customFieldValue'>) | undefined, showFederated?: boolean | undefined, showAdminOnlyContacts?: boolean | undefined, extensionType?: SearchDirectoryContactType | undefined, siteId?: string | undefined, showExternalContacts?: boolean | undefined, accountIds?: Array | undefined, department?: string | undefined, siteIds?: Array | undefined, extensionStatuses?: (Array<'Enabled' | 'Disabled' | 'NotActivated'>) | undefined, extensionTypes?: SearchDirectoryExtensionTypes | undefined, orderBy?: Array | undefined, page?: number | undefined, perPage?: number | undefined}; export type CreateApiRestapiV10AccountAccountIdDirectoryEntriesSearchArgs = {accountId: string, department?: string | undefined, siteId?: string | undefined, extensionStatus?: string | undefined, extensionType?: SearchDirectoryExtensionType | undefined, body: SearchDirectoryEntriesRequest}; export type CreateApiRestapiV10AccountAccountIdDirectoryEntriesSearchOptions = {baseUrl?: string | undefined, OAuth2?: string | undefined, fetch?: typeof fetch | undefined}; 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 phoneNumberResource = z.object({formattedPhoneNumber: z.string().optional(), phoneNumber: z.string().optional(), type: z.string().optional(), label: z.string().optional(), usageType: z.enum(["MobileNumber", "ContactNumber", "DirectNumber", "ForwardedNumber"]).optional(), hidden: z.boolean().optional(), primary: z.boolean().optional()}); export const accountResource = z.object({companyName: z.string().optional(), federatedName: z.string().optional(), id: z.string(), mainNumber: phoneNumberResource.optional()}); export const accountDirectoryProfileImageResource = z.object({etag: z.string().optional(), uri: z.string().optional()}); export const businessSiteResource = z.object({id: z.string().optional(), name: z.string().optional(), code: z.string().optional()}); export const directoryRoleResource = z.object({id: z.string(), name: z.string().optional(), domain: z.string().optional(), displayName: z.string().optional()}); export const callQueueResource = z.object({id: z.string().optional(), name: z.string().optional()}); export const customFieldResource = z.object({id: z.string().optional(), name: z.string().optional(), value: z.string().optional()}); export const groupResource = z.object({id: z.string().optional(), name: z.string().optional()}); export const costCenterResource = z.object({id: z.string().optional(), code: z.string().optional(), name: z.string().optional()}); export const externalIntegrationResource = z.object({id: z.string().optional(), typeId: z.string().optional(), type: z.string().optional(), displayName: z.string().optional(), routingType: z.string().optional(), outboundEdgeId: z.string().optional()}); export const contactSubTypeEnum = z.enum(["Unknown", "VideoPro", "VideoProPlus", "DigitalSignage", "Emergency"]); export const contactResource = z.object({id: z.string(), type: z.enum(["User", "Department", "Announcement", "Voicemail", "SharedLinesGroup", "PagingOnly", "ParkLocation", "IvrMenu", "Limited", "ApplicationExtension", "Site", "Bot", "Room", "ProxyAdmin", "DelegatedLinesGroup", "GroupCallPickup", "External", "RoomConnector", "Unknown"]).optional(), status: z.enum(["Enabled", "Disabled", "Frozen", "NotActivated", "Unassigned", "Unknown"]).optional(), account: accountResource.optional(), department: z.string().optional(), email: z.string().optional(), extensionNumber: z.string().optional(), firstName: z.string().optional(), lastName: z.string().optional(), name: z.string().optional(), jobTitle: z.string().optional(), phoneNumbers: z.array(phoneNumberResource).optional(), profileImage: accountDirectoryProfileImageResource.optional(), site: businessSiteResource.optional(), hidden: z.boolean().optional(), role: directoryRoleResource.optional(), callQueues: z.array(callQueueResource).optional(), customFields: z.array(customFieldResource).optional(), groups: z.array(groupResource).optional(), costCenter: costCenterResource.optional(), integration: externalIntegrationResource.optional(), subType: contactSubTypeEnum.optional()}); export const directoryResource = z.object({paging: enumeratedPagingModel, records: z.array(contactResource)}); 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 }; /** * Search Company Directory Entries * * POST /restapi/v1.0/account/{accountId}/directory/entries/search */ export const createApiRestapiV10AccountAccountIdDirectoryEntriesSearch = async (args: CreateApiRestapiV10AccountAccountIdDirectoryEntriesSearchArgs, options?: CreateApiRestapiV10AccountAccountIdDirectoryEntriesSearchOptions) => { const {baseUrl = "https://platform.ringcentral.com", fetch: fetchFn = fetch, OAuth2} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (args.accountId != null) query.append("accountId", String(args.accountId)) if (args.department != null) query.append("department", String(args.department)) if (args.siteId != null) query.append("siteId", String(args.siteId)) if (args.extensionStatus != null) query.append("extensionStatus", String(args.extensionStatus)) if (args.extensionType != null) query.append("extensionType", String(args.extensionType)) if (OAuth2 !== undefined) headers.set('authorization', `Bearer ${OAuth2}`) const url = `${baseUrl.replace(/\/+$/, '')}/restapi/v1.0/account/${encodeURIComponent(String(args.accountId))}/directory/entries/search${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", 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(directoryResource, await res.json()) };