import {z} from 'zod' export type GetApiAssembliesDDidWvmWvmidEEidBomArgs = {did: string, linkDocumentId?: string | undefined, wvm: 'w' | 'v' | 'm', wvmid: string, eid: string, configuration?: string | undefined, bomColumnIds?: Array | undefined, indented?: boolean | undefined, multiLevel?: boolean | undefined, generateIfAbsent?: boolean | undefined, templateId?: string | undefined, includeExcluded?: boolean | undefined, onlyVisibleColumns?: boolean | undefined, ignoreSubassemblyBomBehavior?: boolean | undefined, includeItemMicroversions?: boolean | undefined, includeTopLevelAssemblyRow?: boolean | undefined, thumbnail?: boolean | undefined, respectSubassemblyBomBehavior?: boolean | undefined}; export type GetApiAssembliesDDidWvmWvmidEEidBomOptions = {baseUrl?: string | undefined, OAuth2?: string | undefined, BasicAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const bTMetadataEnumValueInfo = z.object({label: z.string().optional(), state: z.number().int().optional(), value: z.string().optional()}); export const bTSelectedMetadataEnumValue = z.object({enumOptions: z.array(bTMetadataEnumValueInfo).optional(), selectedValue: z.string().optional()}); export const bTBillOfMaterialsObjectWithPropertiesInfo = z.object({headerIdToValue: z.record(z.string(), z.object({})).optional(), href: z.string().optional(), id: z.string().optional(), name: z.string().optional(), selectedMetadataEnumValues: z.record(z.string(), bTSelectedMetadataEnumValue).optional(), viewRef: z.string().optional()}); export const bTBillOfMaterialsElementInfo = z.object({configuration: z.string().optional(), headerIdToValue: z.record(z.string(), z.object({})).optional(), href: z.string().optional(), id: z.string().optional(), name: z.string().optional(), selectedMetadataEnumValues: z.record(z.string(), bTSelectedMetadataEnumValue).optional(), viewRef: z.string().optional()}); export const bTThumbnailSizeInfo = z.object({href: z.string().optional(), mediaType: z.string().optional(), renderMode: z.string().optional(), sheetName: z.string().optional(), size: z.string().optional(), uniqueId: z.string().optional(), viewOrientation: z.string().optional()}); export const bTThumbnailInfo = z.object({href: z.string().optional(), id: z.string().optional(), secondarySizes: z.array(z.array(bTThumbnailSizeInfo)).optional(), sizes: z.array(bTThumbnailSizeInfo).optional()}); export const bTBillOfMaterialsSourceInfo = z.object({document: bTBillOfMaterialsObjectWithPropertiesInfo.optional(), documentMicroversion: bTBillOfMaterialsObjectWithPropertiesInfo.optional(), element: bTBillOfMaterialsElementInfo.optional(), href: z.string().optional(), thumbnailInfo: bTThumbnailInfo.optional(), version: bTBillOfMaterialsObjectWithPropertiesInfo.optional(), viewHref: z.string().optional(), workspace: bTBillOfMaterialsObjectWithPropertiesInfo.optional()}); export const bTBillOfMaterialsHeaderInfo = z.object({href: z.string().optional(), id: z.string().optional(), name: z.string().optional(), propertyName: z.string().optional(), valueType: z.string().optional(), viewRef: z.string().optional(), visible: z.boolean().optional()}); export const bTBillOfMaterialsItemSourceInfo = z.object({configuration: z.string().optional(), distinctConfigurations: z.array(z.string()).optional(), documentId: z.string().optional(), elementId: z.string().optional(), fullConfiguration: z.string().optional(), href: z.string().optional(), isStandardContent: z.boolean().optional(), nonGeometricItemId: z.string().optional(), partId: z.string().optional(), partIdentity: z.string().optional(), sourceElementMicroversionId: z.string().optional(), thumbnailInfo: bTThumbnailInfo.optional(), versionMetadataWorkspaceMicroversionId: z.string().optional(), viewHref: z.string().optional(), wvmId: z.string().optional(), wvmType: z.string().optional()}); export const bTBillOfMaterialsRowInfo = z.object({headerIdToValue: z.record(z.string(), z.object({})).optional(), href: z.string().optional(), id: z.string().optional(), indentLevel: z.number().int().optional(), itemSource: bTBillOfMaterialsItemSourceInfo.optional(), name: z.string().optional(), relatedOccurrences: z.array(z.string()).optional(), rowId: z.string().optional(), selectedMetadataEnumValues: z.record(z.string(), bTSelectedMetadataEnumValue).optional(), viewRef: z.string().optional()}); export const bTBillOfMaterialsInfo = z.object({bomSource: bTBillOfMaterialsSourceInfo.optional(), createdAt: z.string().optional(), formatVersion: z.string().optional(), headers: z.array(bTBillOfMaterialsHeaderInfo).optional(), href: z.string().optional(), id: z.string().optional(), name: z.string().optional(), rows: z.array(bTBillOfMaterialsRowInfo).optional(), templateId: z.string().optional(), topLevelAssemblyRow: bTBillOfMaterialsRowInfo.optional(), type: z.string().optional(), viewRef: z.string().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 the Bill Of Materials (BOM) content for the specified assembly. * * GET /assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}/bom */ export const getApiAssembliesDDidWvmWvmidEEidBom = async (args: GetApiAssembliesDDidWvmWvmidEEidBomArgs, options?: GetApiAssembliesDDidWvmWvmidEEidBomOptions) => { const {baseUrl = "https://api.onshape.com/api/v17", fetch: fetchFn = fetch, OAuth2, BasicAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json;charset=UTF-8; qs=0.09") if (args.linkDocumentId != null) query.append("linkDocumentId", String(args.linkDocumentId)) if (args.configuration != null) query.append("configuration", String(args.configuration)) for (const item of args.bomColumnIds ?? []) query.append("bomColumnIds", String(item)) if (args.indented != null) query.append("indented", String(args.indented)) if (args.multiLevel != null) query.append("multiLevel", String(args.multiLevel)) if (args.generateIfAbsent != null) query.append("generateIfAbsent", String(args.generateIfAbsent)) if (args.templateId != null) query.append("templateId", String(args.templateId)) if (args.includeExcluded != null) query.append("includeExcluded", String(args.includeExcluded)) if (args.onlyVisibleColumns != null) query.append("onlyVisibleColumns", String(args.onlyVisibleColumns)) if (args.ignoreSubassemblyBomBehavior != null) query.append("ignoreSubassemblyBomBehavior", String(args.ignoreSubassemblyBomBehavior)) if (args.includeItemMicroversions != null) query.append("includeItemMicroversions", String(args.includeItemMicroversions)) if (args.includeTopLevelAssemblyRow != null) query.append("includeTopLevelAssemblyRow", String(args.includeTopLevelAssemblyRow)) if (args.thumbnail != null) query.append("thumbnail", String(args.thumbnail)) if (args.respectSubassemblyBomBehavior != null) query.append("respectSubassemblyBomBehavior", String(args.respectSubassemblyBomBehavior)) if (OAuth2 !== undefined) headers.set('authorization', `Bearer ${OAuth2}`) if (BasicAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${BasicAuth.username}:${BasicAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/assemblies/d/${encodeURIComponent(String(args.did))}/${encodeURIComponent(String(args.wvm))}/${encodeURIComponent(String(args.wvmid))}/e/${encodeURIComponent(String(args.eid))}/bom${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(bTBillOfMaterialsInfo, await res.json()) };