import {z} from 'zod' export type GetApiSalesOrdersIdArgs = {txn_number?: string | undefined}; export type GetApiSalesOrdersIdOptions = {baseUrl?: string | undefined, accountId?: string | undefined, authToken?: string | undefined, fetch?: typeof fetch | undefined}; export const namedRef = z.object({id: z.string().optional(), name: z.string().optional()}); export const party = z.object({id: z.string().optional(), name: z.string().nullable().optional(), initials: z.string().nullable().optional()}); export const address = z.object({id: z.string().optional(), addressType: z.string().nullable().optional(), name: z.string().nullable().optional(), nameStreet: z.string().nullable().optional(), nameStreetCity: z.string().nullable().optional(), street: z.string().nullable().optional(), street1: z.string().nullable().optional(), suburb: z.string().nullable().optional(), city: z.string().nullable().optional(), zip: z.string().nullable().optional(), state: z.string().nullable().optional(), country: z.string().nullable().optional(), attentionTo: z.string().nullable().optional(), coordinates: z.object({latitude: z.number().nullable().optional(), longitude: z.number().nullable().optional()}).optional()}); export const salesOrderLineItem = z.object({id: z.string().optional(), workOrderId: z.string().optional(), companyId: z.string().nullable().optional(), position: z.number().int().optional(), name: z.string().nullable().optional(), description: z.string().nullable().optional(), fullDescription: z.string().nullable().optional(), quantity: z.number().optional(), uom: z.string().nullable().optional(), volumeDiscountPercent: z.number().nullable().optional(), volumeDiscountInDollars: z.number().nullable().optional(), rangeDiscountPercent: z.number().nullable().optional(), rangeDiscountInDollars: z.number().nullable().optional(), costInDollars: z.number().nullable().optional(), suggestedPriceInDollars: z.number().nullable().optional(), priceInDollars: z.number().nullable().optional(), totalCostInDollars: z.number().nullable().optional(), totalPriceInDollars: z.number().nullable().optional(), totalTaxInDollars: z.number().nullable().optional(), workflowState: z.string().nullable().optional(), productId: z.string().nullable().optional(), productType: z.string().nullable().optional(), productName: z.string().nullable().optional(), saleType: z.string().nullable().optional(), jobId: z.string().nullable().optional(), taxable: z.boolean().optional(), taxName: z.string().nullable().optional(), taxRate: z.number().nullable().optional(), priceOverride: z.boolean().nullable().optional(), parentLineItemId: z.string().nullable().optional(), customFields: z.array(z.object({name: z.string().optional(), type: z.string().nullable().optional(), value: z.string().nullable().optional()})).optional(), job: z.object({id: z.string().optional(), name: z.string().nullable().optional(), workflowState: z.string().nullable().optional()}).optional()}); export const signature = z.object({name: z.string().optional(), location: z.string().nullable().optional(), signatureUrl: z.string().nullable().optional(), createdAt: z.string().optional()}); export const salesOrder = z.object({className: z.string().optional(), active: z.boolean().optional(), id: z.string().optional(), title: z.string().optional(), description: z.string().nullable().optional(), txnDate: z.string().nullable().optional(), txnNumber: z.string().optional(), totalPriceInDollars: z.number().nullable().optional(), totalTaxInDollars: z.number().nullable().optional(), totalPriceWithTaxInDollars: z.number().nullable().optional(), totalPaymentsInDollars: z.number().nullable().optional(), balanceInDollars: z.number().nullable().optional(), workflowState: z.string().nullable().optional(), dueDate: z.string().nullable().optional(), inHandDate: z.string().nullable().optional(), shippingDate: z.string().nullable().optional(), customerPoNumber: z.string().nullable().optional(), customerPoDate: z.string().nullable().optional(), downpaymentPercent: z.number().nullable().optional(), invoiced: z.boolean().nullable().optional(), fullyInvoiced: z.boolean().nullable().optional(), setupChargesInDollars: z.number().nullable().optional(), setupChargesTaxable: z.boolean().optional(), miscChargesInDollars: z.number().nullable().optional(), miscChargesTaxable: z.boolean().optional(), miscChargesLabel: z.string().nullable().optional(), shippingChargesInDollars: z.number().nullable().optional(), shippingChargesTaxable: z.boolean().optional(), financeChargesInDollars: z.number().nullable().optional(), financeChargesTaxable: z.boolean().optional(), companyId: z.string().nullable().optional(), primarySalesRepId: z.string().nullable().optional(), primaryContactId: z.string().nullable().optional(), billingAddressId: z.string().nullable().optional(), shippingAddressId: z.string().nullable().optional(), termCodeId: z.string().nullable().optional(), salesTaxId: z.string().nullable().optional(), shippingMethodId: z.string().nullable().optional(), productionManagerId: z.string().nullable().optional(), projectManagerId: z.string().nullable().optional(), designerId: z.string().nullable().optional(), paymentMethodId: z.string().nullable().optional(), createdAt: z.string().optional(), updatedAt: z.string().optional(), company: namedRef.optional(), primaryContact: namedRef.optional(), primarySalesRep: party.optional(), productionManager: party.optional(), projectManager: party.optional(), designer: party.optional(), project: namedRef.optional(), createdBy: namedRef.optional(), updatedBy: namedRef.optional(), billingAddress: address.optional(), shippingAddress: address.optional(), shippingMethod: namedRef.optional(), paymentMethod: namedRef.optional(), tax: z.object({id: z.string().optional(), name: z.string().nullable().optional(), rate: z.number().nullable().optional(), rateInPercent: z.string().nullable().optional()}).optional(), termCode: z.object({id: z.string().optional(), name: z.string().nullable().optional(), type: z.string().nullable().optional(), days: z.number().int().nullable().optional()}).optional(), lineItems: z.array(salesOrderLineItem).optional(), relatedTransactions: z.array(z.object({txnId: z.string().optional(), txnNumber: z.string().optional(), txnDate: z.string().nullable().optional(), txnName: z.string().nullable().optional(), txnType: z.string().nullable().optional(), txnTotal: z.number().nullable().optional()})).optional(), orderPayments: z.array(z.object({orderPaymentId: z.string().optional(), orderPaymentTxnNumber: z.string().optional(), orderPaymentPaidOn: z.string().nullable().optional(), orderPaymentAmount: z.number().nullable().optional()})).optional(), signatures: z.array(signature).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 a sales order * * GET /sales_orders/{id} */ export const getApiSalesOrdersId = async (args: GetApiSalesOrdersIdArgs, options?: GetApiSalesOrdersIdOptions) => { const {baseUrl = "https://api.shopvox.com/v1", fetch: fetchFn = fetch, accountId, authToken} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.txn_number != null) query.append("txn_number", String(args.txn_number)) if (accountId !== undefined) query.set("account_id", accountId) if (authToken !== undefined) query.set("authToken", authToken) const url = `${baseUrl.replace(/\/+$/, '')}/sales_orders/${encodeURIComponent(String(args.id))}${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(salesOrder, await res.json()) };