import {z} from 'zod' export type GetApiOcapiV1SitesSiteIdItemProfileArgs = {siteId: string, 'Connect-Region-Code'?: string | undefined}; export type GetApiOcapiV1SitesSiteIdItemProfileOptions = {baseUrl: string, fetch?: typeof fetch | undefined}; export const ocapiV1Translation = z.object({languageTag: z.string().min(1), text: z.string().min(1)}); export const ocapiV1Translatable = z.object({text: z.string().min(1), translations: z.array(ocapiV1Translation)}); export const ocapiV1MonetaryValue = z.object({valueIncludingTax: z.number(), valueExcludingTax: z.number(), tax: z.number()}); export const ocapiV1SalesMasterDataItemsPricesItemPriceRestriction = z.enum(["MemberReward", "InheritedMemberReward", "Discount", "InheritedDiscount"]); export const ocapiV1DiscountCalculationsDiscountCalculationType = z.enum(["SpecialPrice", "PercentageOff", "PriceOff"]); export const ocapiV1DiscountCalculationsPercentageOffDiscountCalculation = z.object({percentageOff: z.number(), type: ocapiV1DiscountCalculationsDiscountCalculationType}); export const ocapiV1DiscountCalculationsPriceOffDiscountCalculation = z.object({priceOff: z.number(), type: ocapiV1DiscountCalculationsDiscountCalculationType}); export const ocapiV1DiscountCalculationsSpecialPriceDiscountCalculation = z.object({specialPrice: z.number(), type: ocapiV1DiscountCalculationsDiscountCalculationType}); export const ocapiV1SalesMasterDataPricesPriceDiscount = z.object({calculation: z.union([ocapiV1DiscountCalculationsPercentageOffDiscountCalculation, ocapiV1DiscountCalculationsPriceOffDiscountCalculation, ocapiV1DiscountCalculationsSpecialPriceDiscountCalculation]), amountSaved: ocapiV1MonetaryValue}); export const ocapiV1SalesMasterDataItemsPricesItemPrice = z.object({price: ocapiV1MonetaryValue, isDefault: z.boolean(), restrictions: z.array(ocapiV1SalesMasterDataItemsPricesItemPriceRestriction), rewardId: z.number().int().nullable().optional(), discount: ocapiV1SalesMasterDataPricesPriceDiscount.optional(), discountId: z.string().nullable().optional()}); export const ocapiV1SalesMasterDataItemsProfilesItemProfileButton = z.object({itemId: z.string().min(1), prices: z.array(ocapiV1SalesMasterDataItemsPricesItemPrice), title: ocapiV1Translatable, displayPriority: z.number().int()}); export const ocapiV1SalesMasterDataItemsProfilesItemProfilePage = z.object({number: z.number().int(), title: ocapiV1Translatable, buttons: z.array(ocapiV1SalesMasterDataItemsProfilesItemProfileButton), displayPriority: z.number().int()}); export const ocapiV1SalesMasterDataOrderTipOptionsOrderTipOption = z.object({percentage: z.number().int(), isDefault: z.boolean()}); export const ocapiV1SalesMasterDataItemsShowtimeDeliveryWindowsItemShowtimeDeliveryWindowType = z.literal("MinutesFromStart"); export const ocapiV1SalesMasterDataItemsShowtimeDeliveryWindowsItemShowtimeDeliveryWindowMinutesFromStart = z.object({id: z.string().min(1), name: ocapiV1Translatable, type: ocapiV1SalesMasterDataItemsShowtimeDeliveryWindowsItemShowtimeDeliveryWindowType}); export const ocapiV1SalesMasterDataItemsDeliveryFeesItemDeliveryFeeType = z.enum(["FixedPrice", "Percentage"]); export const ocapiV1SalesMasterDataItemsDeliveryFeesItemDeliveryFeeFixedPrice = z.object({type: ocapiV1SalesMasterDataItemsDeliveryFeesItemDeliveryFeeType, price: ocapiV1MonetaryValue}); export const ocapiV1SalesMasterDataItemsDeliveryFeesItemDeliveryFeePercentage = z.object({type: ocapiV1SalesMasterDataItemsDeliveryFeesItemDeliveryFeeType, percentage: z.number(), salesTaxId: z.string().min(1)}); export const ocapiV1SalesMasterDataItemsProfilesSiteItemProfile = z.object({pages: z.array(ocapiV1SalesMasterDataItemsProfilesItemProfilePage), siteId: z.string().min(1), isDefault: z.boolean(), orderTipOptions: z.array(ocapiV1SalesMasterDataOrderTipOptionsOrderTipOption), itemShowtimeDeliveryWindows: z.array(ocapiV1SalesMasterDataItemsShowtimeDeliveryWindowsItemShowtimeDeliveryWindowMinutesFromStart), customLocationItemDeliveryFee: z.union([ocapiV1SalesMasterDataItemsDeliveryFeesItemDeliveryFeeFixedPrice, ocapiV1SalesMasterDataItemsDeliveryFeesItemDeliveryFeePercentage]).optional(), counterItemPickupFee: z.union([ocapiV1SalesMasterDataItemsDeliveryFeesItemDeliveryFeeFixedPrice, ocapiV1SalesMasterDataItemsDeliveryFeesItemDeliveryFeePercentage]).optional(), serviceAreaItemPickupFee: z.union([ocapiV1SalesMasterDataItemsDeliveryFeesItemDeliveryFeeFixedPrice, ocapiV1SalesMasterDataItemsDeliveryFeesItemDeliveryFeePercentage]).optional(), siteOrderLocationId: z.string().nullable().optional()}); export const ocapiV1SalesMasterDataDiscountsDiscountRestriction = z.enum(["None", "Multiple", "MemberReward", "Voucher", "Availability"]); export const ocapiV1SalesMasterDataDiscountsDiscount = z.object({id: z.string().min(1), name: ocapiV1Translatable, restriction: ocapiV1SalesMasterDataDiscountsDiscountRestriction, restrictions: z.array(ocapiV1SalesMasterDataDiscountsDiscountRestriction), rewardIds: z.array(z.number().int()), voucherTypeCodes: z.array(z.string()), expiresAt: z.string()}); export const ocapiV1SalesMasterDataItemsItemRestriction = z.enum(["Member", "AvailableHours"]); export const ocapiV1SalesMasterDataItemsItemType = z.enum(["Normal", "ParentSales", "Package", "Recipe", "WeightBased"]); export const ocapiV1SalesMasterDataItemsDeliveryMethodsItemDeliveryMethod = z.enum(["CounterPickup", "ServiceAreaPickup", "ElectronicDelivery", "InSeatDelivery", "DiningLocationDelivery", "CustomLocationDelivery", "PostalDelivery"]); export const ocapiV1SalesMasterDataItemsWeightBasedWeightBasedItem = z.object({id: z.string().min(1), name: ocapiV1Translatable, shortName: ocapiV1Translatable, description: ocapiV1Translatable.optional(), restrictions: z.array(ocapiV1SalesMasterDataItemsItemRestriction), type: ocapiV1SalesMasterDataItemsItemType, itemClassId: z.string().nullable().optional(), hopk: z.string().nullable().optional(), hoCode: z.string().min(1), isSundry: z.boolean(), isPreparationRequired: z.boolean(), allowedDeliveryMethods: z.array(ocapiV1SalesMasterDataItemsDeliveryMethodsItemDeliveryMethod), availableHoursId: z.string().nullable().optional(), barcodes: z.array(z.string())}); export const ocapiV1SalesMasterDataItemsNormalNormalItemModifierGroup = z.object({itemModifierGroupId: z.string().min(1), displayPriority: z.number().int()}); export const ocapiV1SalesMasterDataItemsRecipeRecipeItemComponent = z.object({itemId: z.string().min(1), isModifiable: z.boolean(), displayPriority: z.number().int(), prices: z.array(ocapiV1SalesMasterDataItemsPricesItemPrice)}); export const ocapiV1SalesMasterDataItemsRecipeRecipeItem = z.object({id: z.string().min(1), name: ocapiV1Translatable, shortName: ocapiV1Translatable, description: ocapiV1Translatable.optional(), restrictions: z.array(ocapiV1SalesMasterDataItemsItemRestriction), itemClassId: z.string().nullable().optional(), hopk: z.string().nullable().optional(), hoCode: z.string().min(1), isSundry: z.boolean(), isPreparationRequired: z.boolean(), allowedDeliveryMethods: z.array(ocapiV1SalesMasterDataItemsDeliveryMethodsItemDeliveryMethod), availableHoursId: z.string().nullable().optional(), barcodes: z.array(z.string()), modifierGroups: z.array(ocapiV1SalesMasterDataItemsNormalNormalItemModifierGroup), type: ocapiV1SalesMasterDataItemsItemType, components: z.array(ocapiV1SalesMasterDataItemsRecipeRecipeItemComponent)}); export const ocapiV1SalesMasterDataItemsParentSalesParentSalesItem = z.object({id: z.string().min(1), name: ocapiV1Translatable, shortName: ocapiV1Translatable, description: ocapiV1Translatable.optional(), restrictions: z.array(ocapiV1SalesMasterDataItemsItemRestriction), type: ocapiV1SalesMasterDataItemsItemType, itemClassId: z.string().nullable().optional(), hopk: z.string().nullable().optional(), hoCode: z.string().min(1), isSundry: z.boolean(), isPreparationRequired: z.boolean(), allowedDeliveryMethods: z.array(ocapiV1SalesMasterDataItemsDeliveryMethodsItemDeliveryMethod), availableHoursId: z.string().nullable().optional(), barcodes: z.array(z.string())}); export const ocapiV1SalesMasterDataItemsPackagesPackageItem = z.object({id: z.string().min(1), name: ocapiV1Translatable, shortName: ocapiV1Translatable, description: ocapiV1Translatable.optional(), restrictions: z.array(ocapiV1SalesMasterDataItemsItemRestriction), type: ocapiV1SalesMasterDataItemsItemType, itemClassId: z.string().nullable().optional(), hopk: z.string().nullable().optional(), hoCode: z.string().min(1), isSundry: z.boolean(), isPreparationRequired: z.boolean(), allowedDeliveryMethods: z.array(ocapiV1SalesMasterDataItemsDeliveryMethodsItemDeliveryMethod), availableHoursId: z.string().nullable().optional(), barcodes: z.array(z.string())}); export const ocapiV1SalesMasterDataItemsNormalNormalItem = z.object({id: z.string().min(1), name: ocapiV1Translatable, shortName: ocapiV1Translatable, description: ocapiV1Translatable.optional(), restrictions: z.array(ocapiV1SalesMasterDataItemsItemRestriction), type: ocapiV1SalesMasterDataItemsItemType, itemClassId: z.string().nullable().optional(), hopk: z.string().nullable().optional(), hoCode: z.string().min(1), isSundry: z.boolean(), isPreparationRequired: z.boolean(), allowedDeliveryMethods: z.array(ocapiV1SalesMasterDataItemsDeliveryMethodsItemDeliveryMethod), availableHoursId: z.string().nullable().optional(), barcodes: z.array(z.string())}); export const ocapiV1QuantityLimit = z.object({isUnlimited: z.boolean(), maximum: z.number().int().nullable().optional(), minimum: z.number().int()}); export const ocapiV1SalesMasterDataItemsModifiersItemModifier = z.object({itemId: z.string().min(1), prices: z.array(ocapiV1SalesMasterDataItemsPricesItemPrice), displayPriority: z.number().int()}); export const ocapiV1SalesMasterDataItemsModifiersItemModifierGroup = z.object({id: z.string().min(1), name: ocapiV1Translatable, shortName: ocapiV1Translatable, promptText: ocapiV1Translatable.optional(), quantityLimit: ocapiV1QuantityLimit, includedQuantity: z.number().int(), modifiers: z.array(ocapiV1SalesMasterDataItemsModifiersItemModifier)}); export const ocapiV1GeographicLocation = z.object({latitude: z.number(), longitude: z.number()}); export const ocapiV1PhoneNumberType = z.enum(["Home", "Mobile", "Work", "Business", "Fax"]); export const ocapiV1PhoneNumber = z.object({type: ocapiV1PhoneNumberType, number: z.string().min(1)}); export const ocapiV1BrowsingMasterDataSitesSiteAddress = z.object({line1: z.string().nullable().optional(), line2: z.string().nullable().optional(), city: z.string().nullable().optional()}); export const ocapiV1BrowsingMasterDataSitesSiteAddressV2 = z.object({line1: ocapiV1Translatable.optional(), line2: ocapiV1Translatable.optional(), line3: ocapiV1Translatable.optional(), line4: ocapiV1Translatable.optional()}); export const ocapiV1BrowsingMasterDataSitesSiteContactDetails = z.object({phoneNumbers: z.array(ocapiV1PhoneNumber), email: z.string().nullable().optional(), address: ocapiV1BrowsingMasterDataSitesSiteAddress.optional(), addressV2: ocapiV1BrowsingMasterDataSitesSiteAddressV2}); export const ocapiV1LoyaltyMasterDataSitesLoyaltySite = z.object({location: ocapiV1GeographicLocation.optional(), contactDetails: ocapiV1BrowsingMasterDataSitesSiteContactDetails, ianaTimeZoneName: z.string().min(1), id: z.string().min(1), name: ocapiV1Translatable, hasSellableItems: z.boolean(), allowedItemDeliveryMethods: z.array(ocapiV1SalesMasterDataItemsDeliveryMethodsItemDeliveryMethod)}); export const ocapiV1BrowsingMasterDataSitesSite = z.object({id: z.string().min(1), name: ocapiV1Translatable, location: ocapiV1GeographicLocation.optional(), contactDetails: ocapiV1BrowsingMasterDataSitesSiteContactDetails, ianaTimeZoneName: z.string().min(1), hasSellableItems: z.boolean(), allowedItemDeliveryMethods: z.array(ocapiV1SalesMasterDataItemsDeliveryMethodsItemDeliveryMethod)}); export const systemDayOfWeek = z.enum(["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"]); export const ocapiV1SalesMasterDataAvailableHoursAvailableHoursForDay = z.object({day: systemDayOfWeek, startTime: z.string(), endTime: z.string()}); export const ocapiV1SalesMasterDataAvailableHoursAvailableHours = z.object({id: z.string().min(1), siteId: z.string().min(1), days: z.array(ocapiV1SalesMasterDataAvailableHoursAvailableHoursForDay)}); export const ocapiV1SalesMasterDataSalesTaxesSalesTaxLevelType = z.enum(["FixedPrice", "Percentage"]); export const ocapiV1SalesMasterDataTaxSalesTaxLevelFixedPrice = z.object({type: ocapiV1SalesMasterDataSalesTaxesSalesTaxLevelType, price: z.number()}); export const ocapiV1SalesMasterDataTaxSalesTaxLevelPercentage = z.object({type: ocapiV1SalesMasterDataSalesTaxesSalesTaxLevelType, percentage: z.number()}); export const ocapiV1SalesMasterDataTaxSalesTax = z.object({id: z.string().min(1), level1: z.union([ocapiV1SalesMasterDataTaxSalesTaxLevelFixedPrice, ocapiV1SalesMasterDataTaxSalesTaxLevelPercentage]), level2: z.union([ocapiV1SalesMasterDataTaxSalesTaxLevelFixedPrice, ocapiV1SalesMasterDataTaxSalesTaxLevelPercentage]), level3: z.union([ocapiV1SalesMasterDataTaxSalesTaxLevelFixedPrice, ocapiV1SalesMasterDataTaxSalesTaxLevelPercentage]), level4: z.union([ocapiV1SalesMasterDataTaxSalesTaxLevelFixedPrice, ocapiV1SalesMasterDataTaxSalesTaxLevelPercentage])}); export const ocapiV1SalesMasterDataItemsProfilesSiteItemProfileRelatedData = z.object({discounts: z.array(ocapiV1SalesMasterDataDiscountsDiscount), items: z.array(z.union([ocapiV1SalesMasterDataItemsWeightBasedWeightBasedItem, ocapiV1SalesMasterDataItemsRecipeRecipeItem, ocapiV1SalesMasterDataItemsParentSalesParentSalesItem, ocapiV1SalesMasterDataItemsPackagesPackageItem, ocapiV1SalesMasterDataItemsNormalNormalItem])), itemModifierGroups: z.array(ocapiV1SalesMasterDataItemsModifiersItemModifierGroup), site: z.union([ocapiV1LoyaltyMasterDataSitesLoyaltySite, ocapiV1BrowsingMasterDataSitesSite]), availableHours: z.array(ocapiV1SalesMasterDataAvailableHoursAvailableHours), salesTaxes: z.array(ocapiV1SalesMasterDataTaxSalesTax)}); export const ocapiV1SalesMasterDataItemsProfilesSiteItemProfileDetails = z.object({itemProfile: ocapiV1SalesMasterDataItemsProfilesSiteItemProfile, relatedData: ocapiV1SalesMasterDataItemsProfilesSiteItemProfileRelatedData}); 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 }; /** * Gets the site item profile and its related data for a specified site * * GET /ocapi/v1/sites/{siteId}/item-profile */ export const getApiOcapiV1SitesSiteIdItemProfile = async (args: GetApiOcapiV1SitesSiteIdItemProfileArgs, options: GetApiOcapiV1SitesSiteIdItemProfileOptions) => { const {baseUrl, fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args['Connect-Region-Code'] != null) headers.set("Connect-Region-Code", String(args['Connect-Region-Code'])) const url = `${baseUrl.replace(/\/+$/, '')}/ocapi/v1/sites/${encodeURIComponent(String(args.siteId))}/item-profile${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(ocapiV1SalesMasterDataItemsProfilesSiteItemProfileDetails, await res.json()) };