import {z} from 'zod' export type DeviceInfoRequest = {id?: string | undefined, appExternalId?: string | undefined, computerName?: string | undefined, serial?: string | undefined}; export type SIPInfoRequest = {transport?: ('UDP' | 'TCP' | 'TLS' | 'WSS') | undefined}; export type CreateSipRegistrationRequest = {device?: DeviceInfoRequest | undefined, sipInfo?: Array | undefined, softPhoneLineReassignment?: ('None' | 'Initialize' | 'Reassign') | undefined}; export type CreateApiRestapiV10ClientInfoSipProvisionArgs = {body: CreateSipRegistrationRequest}; export type CreateApiRestapiV10ClientInfoSipProvisionOptions = {baseUrl?: string | undefined, OAuth2?: string | undefined, fetch?: typeof fetch | undefined}; export const deviceAddonInfo = z.object({id: z.string().optional(), name: z.string().optional(), count: z.number().int().optional()}); export const deviceModelInfo = z.object({id: z.string().optional(), name: z.string().optional(), addons: z.array(deviceAddonInfo), features: z.array(z.enum(["BLA", "Intercom", "Paging", "HELD"])).optional()}); export const deviceExtensionInfo = z.object({id: z.number().int().optional(), uri: z.string().optional(), extensionNumber: z.string().optional()}); export const deviceEmergencyServiceAddressResourceDefault = z.object({street: z.string().optional(), street2: z.string().optional(), city: z.string().optional(), zip: z.string().optional(), customerName: z.string().optional(), state: z.string().optional(), stateId: z.string().optional(), stateIsoCode: z.string().optional(), stateName: z.string().optional(), countryId: z.string().optional(), countryIsoCode: z.string().optional(), country: z.string().optional(), countryName: z.string().optional(), outOfCountry: z.boolean().optional()}); export const deviceEmergencyServiceAddressResourceAu = z.object({street: z.string().optional(), street2: z.string().optional(), city: z.string().optional(), zip: z.string().optional(), customerName: z.string().optional(), state: z.string().optional(), stateId: z.string().optional(), stateIsoCode: z.string().optional(), stateName: z.string().optional(), countryId: z.string().optional(), countryIsoCode: z.string().optional(), country: z.string().optional(), countryName: z.string().optional(), outOfCountry: z.boolean().optional(), buildingName: z.string().optional(), streetType: z.string().optional(), buildingNumber: z.string().optional()}); export const deviceEmergencyServiceAddressResourceFr = z.object({street: z.string().optional(), street2: z.string().optional(), city: z.string().optional(), zip: z.string().optional(), customerName: z.string().optional(), state: z.string().optional(), stateId: z.string().optional(), stateIsoCode: z.string().optional(), stateName: z.string().optional(), countryId: z.string().optional(), countryIsoCode: z.string().optional(), country: z.string().optional(), countryName: z.string().optional(), outOfCountry: z.boolean().optional(), buildingName: z.string().optional(), buildingNumber: z.string().optional()}); export const sipRegistrationDeviceLocationInfo = z.object({id: z.string().optional(), name: z.string().optional(), addressFormatId: z.string().optional()}); export const sipRegistrationDeviceEmergencyInfo = z.object({address: z.union([deviceEmergencyServiceAddressResourceDefault, deviceEmergencyServiceAddressResourceAu, deviceEmergencyServiceAddressResourceFr]).optional(), location: sipRegistrationDeviceLocationInfo.optional(), outOfCountry: z.boolean().optional(), addressStatus: z.enum(["Valid", "Invalid", "Processing"]).optional(), visibility: z.enum(["Private", "Public"]).optional(), syncStatus: z.enum(["Verified", "Updated", "Deleted", "NotRequired", "Unsupported", "Failed"]).optional(), addressEditableStatus: z.enum(["MainDevice", "AnyDevice"]).optional(), addressRequired: z.boolean().optional(), addressLocationOnly: z.boolean().optional()}); export const shippingStatus = z.enum(["Initial", "Accepted", "Shipped"]); export const shippingMethodInfo = z.object({id: z.enum(["1", "2", "3"]), name: z.enum(["Ground", "2 Day", "Overnight"]).optional()}); export const shippingAddressInfo = z.object({customerName: z.string().optional(), additionalCustomerName: z.string().optional(), customerEmail: z.string().optional(), additionalCustomerEmail: z.string().optional(), customerPhone: z.string().optional(), additionalCustomerPhone: z.string().optional(), street: z.string().optional(), street2: z.string().optional(), city: z.string().optional(), state: z.string().optional(), stateId: z.string().optional(), stateIsoCode: z.string().optional(), stateName: z.string().optional(), countryId: z.string().optional(), countryIsoCode: z.string().optional(), country: z.string().optional(), countryName: z.string().optional(), zip: z.string().optional(), taxId: z.string().optional()}); export const shippingInfo = z.object({status: shippingStatus.optional(), carrier: z.string().optional(), trackingNumber: z.string().optional(), method: shippingMethodInfo.optional(), address: shippingAddressInfo.optional()}); export const devicePhoneLinesEmergencyAddressInfo = z.object({required: z.boolean().optional(), localOnly: z.boolean().optional()}); export const devicePhoneNumberCountryInfo = z.object({id: z.string().optional(), uri: z.string().optional(), name: z.string().optional()}); export const devicePhoneNumberInfo = z.object({id: z.number().int().optional(), country: devicePhoneNumberCountryInfo.optional(), paymentType: z.enum(["External", "TollFree", "Local"]).optional(), phoneNumber: z.string().max(128).optional(), usageType: z.enum(["CompanyNumber", "MainCompanyNumber", "AdditionalCompanyNumber", "DirectNumber", "CompanyFaxNumber", "ForwardedNumber", "ForwardedCompanyNumber", "ContactCenterNumber"]).optional(), type: z.enum(["VoiceFax", "FaxOnly", "VoiceOnly"]).optional()}); export const devicePhoneLinesInfo = z.object({id: z.string().optional(), lineType: z.enum(["Standalone", "StandaloneFree", "BlaPrimary", "BlaSecondary"]).optional(), emergencyAddress: devicePhoneLinesEmergencyAddressInfo.optional(), phoneInfo: devicePhoneNumberInfo.optional()}); export const linePoolingEnum = z.enum(["Host", "Guest", "None"]); export const deviceSiteInfo = z.object({id: z.string().optional(), name: z.string().optional()}); export const sipRegistrationDeviceInfo = z.object({uri: z.string().optional(), id: z.string().optional(), type: z.enum(["HardPhone", "SoftPhone", "OtherPhone", "Paging", "WebPhone", "Room"]).optional(), sku: z.string().optional(), status: z.enum(["Online", "Offline"]).optional(), name: z.string().optional(), serial: z.string().optional(), computerName: z.string().optional(), model: deviceModelInfo.optional(), extension: deviceExtensionInfo.optional(), emergencyServiceAddress: deviceEmergencyServiceAddressResourceDefault.optional(), emergency: sipRegistrationDeviceEmergencyInfo.optional(), shipping: shippingInfo.optional(), phoneLines: z.array(devicePhoneLinesInfo).optional(), boxBillingId: z.number().int().optional(), useAsCommonPhone: z.boolean().optional(), linePooling: linePoolingEnum.optional(), inCompanyNet: z.boolean().optional(), site: deviceSiteInfo.optional(), lastLocationReportTime: z.string().optional()}); export const authorizationType = z.enum(["SipDigest", "BearerToken"]); export const sipInfoResponse = z.object({username: z.string().optional(), password: z.string().optional(), authorizationTypes: z.array(authorizationType).optional(), authorizationId: z.string().optional(), domain: z.string().optional(), outboundProxy: z.string().optional(), outboundProxyIPv6: z.string().optional(), outboundProxyBackup: z.string().optional(), outboundProxyIPv6Backup: z.string().optional(), transport: z.enum(["UDP", "TCP", "TLS", "WSS"]).optional(), certificate: z.string().optional(), switchBackInterval: z.number().int().optional(), stunServers: z.array(z.string()).optional()}); export const sipFlagsResponse = z.object({voipFeatureEnabled: z.boolean().optional(), voipCountryBlocked: z.boolean().optional(), outboundCallsEnabled: z.boolean().optional(), dscpEnabled: z.boolean().optional(), dscpSignaling: z.number().int().optional(), dscpVoice: z.number().int().optional(), dscpVideo: z.number().int().optional()}); export const createSipRegistrationResponse = z.object({device: sipRegistrationDeviceInfo, sipInfo: z.array(sipInfoResponse), sipInfoPstn: z.array(sipInfoResponse).optional(), sipFlags: sipFlagsResponse, sipErrorCodes: z.array(z.string()).optional(), pollingInterval: z.number().int().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 }; /** * Register Device * * POST /restapi/v1.0/client-info/sip-provision */ export const createApiRestapiV10ClientInfoSipProvision = async (args: CreateApiRestapiV10ClientInfoSipProvisionArgs, options?: CreateApiRestapiV10ClientInfoSipProvisionOptions) => { 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 (OAuth2 !== undefined) headers.set('authorization', `Bearer ${OAuth2}`) const url = `${baseUrl.replace(/\/+$/, '')}/restapi/v1.0/client-info/sip-provision${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(createSipRegistrationResponse, await res.json()) };