import {z} from 'zod' export type GetApiArticleArgs = {page?: number | undefined, pageSize?: number | undefined, sort?: string | undefined, additionalProperties?: string | undefined}; export type GetApiArticleOptions = {baseUrl: string, APIToken?: string | undefined, fetch?: typeof fetch | undefined}; export const articleAlternativeQuantity = z.object({id: z.string().optional(), version: z.string().optional(), createdDate: z.number().int().optional(), lastModifiedDate: z.number().int().optional(), minimumOrderQuantity: z.string().optional(), minimumStockQuantity: z.string().optional(), targetStockQuantity: z.string().optional(), warehouseId: z.string()}); export const articleCalculationPrice = z.object({id: z.string().optional(), version: z.string().optional(), articleCalculationPriceType: z.enum(["CALCULATION_PRICE", "RECOMMENDED_RETAIL_PRICE"]), createdDate: z.number().int().optional(), endDate: z.number().int().optional(), lastModifiedDate: z.number().int().optional(), price: z.string(), salesChannel: z.string().optional(), startDate: z.number().int().optional()}); export const articleImage = z.object({id: z.string().optional(), version: z.string().optional(), createdDate: z.number().int().optional(), fileName: z.string().optional(), lastModifiedDate: z.number().int().optional(), mainImage: z.boolean().optional()}); export const reductionAddition = z.object({id: z.string().optional(), version: z.string().optional(), createdDate: z.number().int().optional(), lastModifiedDate: z.number().int().optional(), name: z.string().optional(), type: z.enum(["ADDITIONAL_ABS", "ADDITION_PERCENT", "REDUCTION_ABS", "REDUCTION_PERCENT"]), value: z.string()}); export const salesPrice = z.object({id: z.string().optional(), version: z.string().optional(), createdDate: z.number().int().optional(), currencyId: z.string(), customerId: z.string().optional(), description: z.string().optional(), endDate: z.number().int().optional(), lastModifiedByUserId: z.string().optional(), lastModifiedDate: z.number().int().optional(), price: z.string(), priceScaleType: z.enum(["SCALE_FROM", "SCALE_TO"]), priceScaleValue: z.string(), reductionAdditions: z.array(reductionAddition).optional(), salesChannel: z.string(), startDate: z.number().int().optional()}); export const entityReference = z.object({entityId: z.string().optional(), entityName: z.string().optional()}); export const onlyId = z.object({id: z.string().optional()}); export const customAttribute = z.object({attributeDefinitionId: z.string().optional(), booleanValue: z.boolean().optional(), dateValue: z.number().int().optional(), entityId: z.string().optional(), entityReferences: z.array(entityReference).optional(), numberValue: z.string().optional(), selectedValueId: z.string().optional(), selectedValues: z.array(onlyId).optional(), stringValue: z.string().optional()}); export const customerSpecificArticleAttributes = z.object({id: z.string().optional(), version: z.string().optional(), createdDate: z.number().int().optional(), customerArticleNumber: z.string(), customerId: z.string(), lastModifiedDate: z.number().int().optional()}); export const billOfMaterial = z.object({id: z.string().optional(), version: z.string().optional(), articleId: z.string(), createdDate: z.number().int().optional(), lastModifiedDate: z.number().int().optional(), positionNumber: z.number().int().optional(), quantity: z.string()}); export const quantityConversion = z.object({id: z.string().optional(), version: z.string().optional(), conversionQuantity: z.string(), createdDate: z.number().int().optional(), createdUserId: z.string().optional(), lastEditedUserId: z.string().optional(), lastModifiedDate: z.number().int().optional(), oppositeDirection: z.boolean().optional(), unitId: z.string()}); export const salesBillOfMaterialArticleItem = z.object({id: z.string().optional(), version: z.string().optional(), articleId: z.string(), createdDate: z.number().int().optional(), lastModifiedDate: z.number().int().optional(), positionNumber: z.number().int().optional(), quantity: z.string()}); export const supplySource = z.object({id: z.string().optional(), version: z.string().optional(), articleSupplySourceId: z.string(), createdDate: z.number().int().optional(), lastModifiedDate: z.number().int().optional(), positionNumber: z.number().int().optional()}); export const article = z.object({id: z.string().optional(), version: z.string().optional(), accountId: z.string().optional(), accountingCodeId: z.string().optional(), active: z.boolean().optional(), applyCashDiscount: z.boolean().optional(), articleAlternativeQuantities: z.array(articleAlternativeQuantity).optional(), articleCalculationPrices: z.array(articleCalculationPrice).optional(), articleCategoryId: z.string().optional(), articleGrossWeight: z.string().optional(), articleHeight: z.string().optional(), articleImages: z.array(articleImage).optional(), articleLength: z.string().optional(), articleNetWeight: z.string().optional(), articleNumber: z.string().optional(), articlePrices: z.array(salesPrice).optional(), articleType: z.enum(["BASIC", "LOADING_EQUIPMENT", "LOADING_EQUIPMENT_STORABLE", "PACKAGING_UNIT", "SALES_BILL_OF_MATERIAL", "SERVICE", "SERVICE_QUOTA", "SHIPPING_COST", "STORABLE"]).optional(), articleWidth: z.string().optional(), availableForSalesChannels: z.array(z.string()).optional(), availableInSale: z.boolean().optional(), averageDeliveryTime: z.number().int().optional(), barcode: z.string().optional(), batchNumberRequired: z.boolean().optional(), billOfMaterialPartDeliveryPossible: z.boolean().optional(), catalogCode: z.string().optional(), commissionRate: z.string().optional(), contractBillingCycle: z.enum(["DAILY", "FIVE_YEARLY", "FOUR_YEARLY", "HALF_YEARLY", "MONTHLY", "NONE", "QUARTER", "THREE_YEARLY", "TWO_YEARLY", "WEEKLY", "YEARLY"]).optional(), contractBillingMode: z.enum(["NON_RECURRENT", "RECURRENT"]).optional(), countryOfOriginCode: z.enum(["AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CS", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DG", "DJ", "DK", "DM", "DO", "DZ", "EA", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "EU", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "UNKNOWN", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XI", "XK", "YE", "YT", "ZA", "ZM", "ZW"]).optional(), createdDate: z.number().int().optional(), customAttributes: z.array(customAttribute).optional(), customerArticleNumbers: z.array(customerSpecificArticleAttributes).optional(), customsDescription: z.string().optional(), customsTariffNumberId: z.string().optional(), defaultLoadingEquipmentIdentifierId: z.string().optional(), defaultPriceCalculationType: z.enum(["MARGIN_CALCULATION", "PURCHASE", "RECOMMENDED_RETAIL_PRICE", "SALES"]).optional(), defaultStoragePlaces: z.array(onlyId).optional(), defineIndividualTaskTemplates: z.boolean().optional(), description: z.string().optional(), ean: z.string().optional(), expenseAccountId: z.string().optional(), expirationDays: z.number().int().optional(), fixedPurchaseQuantity: z.string().optional(), internalNote: z.string().optional(), invoicingType: z.enum(["EFFORT", "FIXED_PRICE"]).optional(), lastModifiedDate: z.number().int().optional(), launchDate: z.number().int().optional(), loadingEquipmentArticleId: z.string().optional(), longText: z.string().optional(), lowLevelCode: z.number().int().optional(), manufacturerId: z.string().optional(), manufacturerPartNumber: z.string().optional(), marginCalculationPriceType: z.enum(["ARTICLE_CALCULATION_PRICE", "EMPLOYEE_COST", "MOVING_AVERAGE", "PURCHASE_PRICE_PRODUCTION_COST"]).optional(), matchCode: z.string().optional(), minimumPurchaseQuantity: z.string().optional(), minimumStockQuantity: z.string().optional(), name: z.string(), packagingQuantity: z.number().int().optional(), packagingUnitBaseArticleId: z.string().optional(), packagingUnitParentArticleId: z.string().optional(), plannedWorkingTimePerUnit: z.number().int().optional(), primarySupplySourceId: z.string().optional(), procurementLeadDays: z.number().int().optional(), producerType: z.string().optional(), productionArticle: z.boolean().optional(), productionBillOfMaterialItems: z.array(billOfMaterial).optional(), productionConfigurationRule: z.enum(["ALL_COMPONENTS", "AT_LEAST_ONE_COMPONENT", "AT_LEAST_ONE_COMPONENT_WITH_VARIABLE_QUANTITY", "ONE_COMPONENT", "ONE_COMPONENT_WITH_VARIABLE_QUANTITY"]).optional(), purchaseCostCenterId: z.string().optional(), quantityConversions: z.array(quantityConversion).optional(), ratingId: z.string().optional(), recordItemGroupName: z.string().optional(), safetyStockDays: z.number().int().optional(), salesBillOfMaterialItems: z.array(salesBillOfMaterialArticleItem).optional(), salesCostCenterId: z.string().optional(), sellByDate: z.number().int().optional(), sellFromDate: z.number().int().optional(), serialNumberRequired: z.boolean().optional(), serviceArticleForServiceQuotaBookingId: z.string().optional(), serviceQuotaQuantity: z.string().optional(), shortDescription1: z.string().optional(), shortDescription2: z.string().optional(), showOnDeliveryNote: z.boolean().optional(), statusId: z.string().optional(), supplySources: z.array(supplySource).optional(), supportUntilDate: z.number().int().optional(), systemCode: z.string().optional(), tags: z.array(z.string()).optional(), targetStockQuantity: z.string().optional(), taxRateType: z.enum(["REDUCED", "SLIGHTLY_REDUCED", "STANDARD", "SUPER_REDUCED", "ZERO"]).optional(), unitId: z.string().optional(), useAvailableForSalesChannels: z.boolean().optional(), useSalesBillOfMaterialItemPrices: z.boolean().optional(), useSalesBillOfMaterialItemPricesForPurchase: z.boolean().optional(), useSalesBillOfMaterialSubitemCosts: z.boolean().optional()}); export const aggregatePackagingUnit = z.object({articleId: z.string().optional(), articleName: z.string().optional(), articleNumber: z.string().optional(), baseArticleQuantity: z.number().int().optional(), packagingUnitQuantity: z.number().int().optional()}); export const aggregateStock = z.object({articleId: z.string().optional(), packagingUnits: z.array(aggregatePackagingUnit).optional(), quantity: z.string().optional(), salesOrderItemId: z.string().optional(), warehouseId: z.string().optional()}); export const amount = z.object({amountInCompanyCurrency: z.string().optional()}); export const priceDataReductionAdditionItem = z.object({position: z.number().int().optional(), source: z.enum(["ARTICLE", "ARTICLE_AND_CUSTOMER", "ARTICLE_CATEGORY", "ARTICLE_CATEGORY_AND_CUSTOMER"]).optional(), specialPriceReduction: z.boolean().optional(), title: z.string().optional(), type: z.enum(["ADDITIONAL_ABS", "ADDITION_PERCENT", "REDUCTION_ABS", "REDUCTION_PERCENT"]).optional(), value: z.string().optional()}); export const priceData = z.object({articleUnitPrice: z.string().optional(), currencyId: z.string().optional(), endDate: z.number().int().optional(), lastModifiedDate: z.number().int().optional(), quantity: z.string().optional(), reductionAdditionItems: z.array(priceDataReductionAdditionItem).optional(), startDate: z.number().int().optional()}); export const warehouseQuantity = z.object({quantity: z.string().optional(), warehouseId: z.string().optional()}); export const getApiArticleResponse = z.object({result: z.array(article).optional(), additionalProperties: z.object({aggregateStock: z.array(z.array(aggregateStock)).optional(), amazonStockQuantity: z.array(z.string()).optional(), averagePrice: z.array(amount).optional(), currentSalesPrice: z.array(priceData).optional(), currentStockMinusTotalSalesVolume: z.array(z.string()).optional(), freeToSaleQuantity: z.array(z.string()).optional(), openShipmentQuantity: z.array(z.string()).optional(), orderedQuantity: z.array(z.string()).optional(), pickableStockQuantity: z.array(z.array(warehouseQuantity)).optional(), plannedSalesQuantity: z.array(z.string()).optional(), reservedStockQuantity: z.array(z.array(warehouseQuantity)).optional(), totalStockQuantity: z.array(z.array(warehouseQuantity)).optional()}).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 }; /** * query article * * GET /article */ export const getApiArticle = async (args: GetApiArticleArgs, options: GetApiArticleOptions) => { const {baseUrl, fetch: fetchFn = fetch, APIToken} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.page != null) query.append("page", String(args.page)) if (args.pageSize != null) query.append("pageSize", String(args.pageSize)) if (args.sort != null) query.append("sort", String(args.sort)) if (args.additionalProperties != null) query.append("additionalProperties", String(args.additionalProperties)) if (APIToken !== undefined) headers.set("AuthenticationToken", APIToken) const url = `${baseUrl.replace(/\/+$/, '')}/article${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(getApiArticleResponse, await res.json()) };