import {z} from 'zod' export type GetApiV2UserChannelCatalogsArgs = {storeId?: unknown | undefined}; export type GetApiV2UserChannelCatalogsOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const beezUPCommonDocUrl = z.string(); export const beezUPCommonHref = z.string(); export const beezUPCommonOperationId = z.string(); export const beezUPCommonHttpMethod = z.enum(["GET", "POST", "PATCH", "DELETE", "PUT", "HEAD"]); export const beezUPCommonParameterIn = z.enum(["path", "header", "query", "body"]); export const beezUPCommonParameterType = z.enum(["string", "integer", "number", "boolean", "object", "array", "date", "date-time"]); export const beezUPCommonLOVLink3 = z.object({href: z.string(), method: beezUPCommonHttpMethod.optional()}); export const beezUPCommonLinkParameterProperty3 = z.object({label: z.string().optional(), value: z.object({}).optional(), required: z.boolean().optional(), type: beezUPCommonParameterType, lovLink: beezUPCommonLOVLink3.optional(), lovRequired: z.boolean().optional(), description: z.string().optional(), schema: z.string().optional()}); export const beezUPCommonLinkParameter3 = z.object({label: z.string().optional(), value: z.object({}).optional(), required: z.boolean().optional(), in: beezUPCommonParameterIn, type: beezUPCommonParameterType.optional(), lovLink: beezUPCommonLOVLink3.optional(), lovRequired: z.boolean().optional(), description: z.string().optional(), schema: z.string().optional(), properties: z.record(z.string(), beezUPCommonLinkParameterProperty3).optional()}); export const beezUPCommonSuccessSummary = z.object({successCode: z.string().optional(), successMessage: z.string().optional(), successArguments: z.record(z.string(), z.string()).optional(), propertyName: z.string().optional(), propertyValue: z.string().optional(), objectName: z.string().optional()}); export const beezUPCommonExceptionDetail = z.object({helpLink: z.string().optional(), message: z.string().optional(), stackTrace: z.string().optional(), type: z.string().optional()}); export const beezUPCommonErrorSummary = z.object({utcDate: z.string().optional(), errorGuid: z.string().optional(), errorCode: z.string().optional(), errorMessage: z.string().optional(), technicalErrorMessage: z.string().optional(), exceptionDetail: beezUPCommonExceptionDetail.optional(), errorArguments: z.record(z.string(), z.string()).optional(), propertyName: z.string().optional(), propertyValue: z.string().optional(), objectName: z.string().optional(), source: z.string().optional()}); export const beezUPCommonWarningSummary = z.object({technicalErrorMessage: z.string().optional(), warningMessage: z.string().optional(), warningCode: z.string().optional(), warningArguments: z.record(z.string(), z.string()).optional()}); export const beezUPCommonInfoSummary = z.object({informationCode: z.string().optional(), informationMessage: z.string().optional(), informationArguments: z.record(z.string(), z.string()).optional(), propertyName: z.string().optional(), propertyValue: z.string().optional(), objectName: z.string().optional()}); export const beezUPCommonInfoSummaries = z.object({successes: z.array(beezUPCommonSuccessSummary).optional(), errors: z.array(beezUPCommonErrorSummary).optional(), warnings: z.array(beezUPCommonWarningSummary).optional(), informations: z.array(beezUPCommonInfoSummary).optional()}); export const linksGetChannelCatalogsLink = z.object({label: z.string().optional(), docUrl: beezUPCommonDocUrl.optional(), description: z.string().optional(), href: beezUPCommonHref, operationId: beezUPCommonOperationId.optional(), method: beezUPCommonHttpMethod.optional(), parameters: z.record(z.string(), beezUPCommonLinkParameter3).optional(), urlTemplated: z.boolean().optional(), allRequiredParamsProvided: z.boolean().optional(), allOptionalParamsProvided: z.boolean().optional(), info: beezUPCommonInfoSummaries.optional()}); export const externalLinksCatalogGetBeezUPColumnsLink = z.object({label: z.string().optional(), docUrl: beezUPCommonDocUrl.optional(), description: z.string().optional(), href: beezUPCommonHref, operationId: beezUPCommonOperationId.optional(), method: beezUPCommonHttpMethod.optional(), parameters: z.record(z.string(), beezUPCommonLinkParameter3).optional(), urlTemplated: z.boolean().optional(), allRequiredParamsProvided: z.boolean().optional(), allOptionalParamsProvided: z.boolean().optional(), info: beezUPCommonInfoSummaries.optional()}); export const linksAddChannelCatalogLink = z.object({label: z.string().optional(), docUrl: beezUPCommonDocUrl.optional(), description: z.string().optional(), href: beezUPCommonHref, operationId: beezUPCommonOperationId.optional(), method: beezUPCommonHttpMethod.optional(), parameters: z.record(z.string(), beezUPCommonLinkParameter3).optional(), urlTemplated: z.boolean().optional(), allRequiredParamsProvided: z.boolean().optional(), allOptionalParamsProvided: z.boolean().optional(), info: beezUPCommonInfoSummaries.optional()}); export const linksGetChannelCatalogFilterOperatorsLink = z.object({label: z.string().optional(), docUrl: beezUPCommonDocUrl.optional(), description: z.string().optional(), href: beezUPCommonHref, operationId: beezUPCommonOperationId.optional(), method: beezUPCommonHttpMethod.optional(), parameters: z.record(z.string(), beezUPCommonLinkParameter3).optional(), urlTemplated: z.boolean().optional(), allRequiredParamsProvided: z.boolean().optional(), allOptionalParamsProvided: z.boolean().optional(), info: beezUPCommonInfoSummaries.optional()}); export const channelCatalogListLinks = z.object({self: linksGetChannelCatalogsLink.optional(), beezUPColumns: externalLinksCatalogGetBeezUPColumnsLink.optional(), add: linksAddChannelCatalogLink.optional(), filterOperators: linksGetChannelCatalogFilterOperatorsLink.optional()}); export const channelCatalogListLovLinks = z.object({channelCatalogExclusionFilterOperatorLov: beezUPCommonLOVLink3.optional(), channelCatalogExportCacheStatusLov: beezUPCommonLOVLink3.optional()}); export const beezUPCommonChannelId = z.string(); export const beezUPCommonChannelName = z.string(); export const beezUPCommonHttpUrl = z.string(); export const beezUPCommonChannelCatalogId = z.string(); export const beezUPCommonStoreId = z.string(); export const generalSettings = z.object({acceptToPublishInfo: z.boolean(), doNotExportOutOfStockProducts: z.boolean(), activeBeezUPTracking: z.boolean()}); export const costType = z.enum(["CPC_Global", "CPA_Global", "CPC_ByCategory", "CPA_ByCategory", "Fixed_Global"]); export const channelCostSettings = z.object({costType: costType, globalCostValue: z.number().optional()}); export const channelCategorySettings = z.object({mappingRequired: z.boolean().optional(), mappingLeafRequired: z.boolean().optional()}); export const costSettings = z.object({costType: costType, globalCostValue: z.number().optional()}); export const channelCatalogCategoryMappingSettings = z.object({categoryMappingDisabledByMerchant: z.boolean().optional()}); export const beezUPCommonChannelColumnId = z.string(); export const beezUPCommonChannelCategoryPath = z.array(z.string()); export const beezUPCommonCatalogColumnId = z.string(); export const beezUPCommonChannelColumnName = z.string(); export const beezUPCommonBeezUPColumnName = z.string(); export const beezUPCommonCatalogColumnUserName = z.string(); export const channelCatalogColumnMappingWithName = z.object({channelColumnId: beezUPCommonChannelColumnId, channelCategoryPath: beezUPCommonChannelCategoryPath.optional(), catalogColumnId: beezUPCommonCatalogColumnId.optional(), channelColumnName: beezUPCommonChannelColumnName, channelBeezUPColumnName: beezUPCommonBeezUPColumnName.optional(), catalogColumnName: beezUPCommonCatalogColumnUserName.optional(), catalogBeezUPColumnName: beezUPCommonBeezUPColumnName.optional()}); export const channelCatalogColumnMappingListWithName = z.array(channelCatalogColumnMappingWithName); export const exclusionFilterName = z.string(); export const filterOperatorName = z.string(); export const exclusionFilter = z.object({name: exclusionFilterName, position: z.number().int().gte(1), groupId: z.string(), positionInGroup: z.number().int().gte(1), channelColumnId: beezUPCommonChannelColumnId, operatorName: filterOperatorName, value: z.string().max(4000).optional(), enabled: z.boolean()}); export const exclusionFilters = z.array(exclusionFilter); export const columnMappingStatus = z.enum(["warning", "success", "failed"]); export const categoryMappingStatus = z.enum(["warning", "success", "failed"]); export const categoryMappingState = z.object({status: categoryMappingStatus.optional(), uncategorizedProductCount: z.number().int().optional(), withoutCategoryCostProductCount: z.number().int().optional()}); export const beezUPCommonApiSettingsStatus = z.enum(["warning", "success", "failed"]); export const channelCatalogState = z.object({exportedProductCount: z.number().int(), columnMappingStatus: columnMappingStatus, categoryMappingState: categoryMappingState, apiSettingsStatus: beezUPCommonApiSettingsStatus.optional()}); export const linksGetChannelCatalogLink = z.object({label: z.string().optional(), docUrl: beezUPCommonDocUrl.optional(), description: z.string().optional(), href: beezUPCommonHref, operationId: beezUPCommonOperationId.optional(), method: beezUPCommonHttpMethod.optional(), parameters: z.record(z.string(), beezUPCommonLinkParameter3).optional(), urlTemplated: z.boolean().optional(), allRequiredParamsProvided: z.boolean().optional(), allOptionalParamsProvided: z.boolean().optional(), info: beezUPCommonInfoSummaries.optional()}); export const linksDeleteChannelCatalogLink = z.object({label: z.string().optional(), docUrl: beezUPCommonDocUrl.optional(), description: z.string().optional(), href: beezUPCommonHref, operationId: beezUPCommonOperationId.optional(), method: beezUPCommonHttpMethod.optional(), parameters: z.record(z.string(), beezUPCommonLinkParameter3).optional(), urlTemplated: z.boolean().optional(), allRequiredParamsProvided: z.boolean().optional(), allOptionalParamsProvided: z.boolean().optional(), info: beezUPCommonInfoSummaries.optional()}); export const linksEnableChannelCatalogLink = z.object({label: z.string().optional(), docUrl: beezUPCommonDocUrl.optional(), description: z.string().optional(), href: beezUPCommonHref, operationId: beezUPCommonOperationId.optional(), method: beezUPCommonHttpMethod.optional(), parameters: z.record(z.string(), beezUPCommonLinkParameter3).optional(), urlTemplated: z.boolean().optional(), allRequiredParamsProvided: z.boolean().optional(), allOptionalParamsProvided: z.boolean().optional(), info: beezUPCommonInfoSummaries.optional()}); export const linksDisableChannelCatalogLink = z.object({label: z.string().optional(), docUrl: beezUPCommonDocUrl.optional(), description: z.string().optional(), href: beezUPCommonHref, operationId: beezUPCommonOperationId.optional(), method: beezUPCommonHttpMethod.optional(), parameters: z.record(z.string(), beezUPCommonLinkParameter3).optional(), urlTemplated: z.boolean().optional(), allRequiredParamsProvided: z.boolean().optional(), allOptionalParamsProvided: z.boolean().optional(), info: beezUPCommonInfoSummaries.optional()}); export const linksConfigureChannelCatalogGeneralSettingsLink = z.object({label: z.string().optional(), docUrl: beezUPCommonDocUrl.optional(), description: z.string().optional(), href: beezUPCommonHref, operationId: beezUPCommonOperationId.optional(), method: beezUPCommonHttpMethod.optional(), parameters: z.record(z.string(), beezUPCommonLinkParameter3).optional(), urlTemplated: z.boolean().optional(), allRequiredParamsProvided: z.boolean().optional(), allOptionalParamsProvided: z.boolean().optional(), info: beezUPCommonInfoSummaries.optional()}); export const linksConfigureChannelCatalogCostSettingsLink = z.object({label: z.string().optional(), docUrl: beezUPCommonDocUrl.optional(), description: z.string().optional(), href: beezUPCommonHref, operationId: beezUPCommonOperationId.optional(), method: beezUPCommonHttpMethod.optional(), parameters: z.record(z.string(), beezUPCommonLinkParameter3).optional(), urlTemplated: z.boolean().optional(), allRequiredParamsProvided: z.boolean().optional(), allOptionalParamsProvided: z.boolean().optional(), info: beezUPCommonInfoSummaries.optional()}); export const linksConfigureChannelCatalogColumnMappingsLink = z.object({label: z.string().optional(), docUrl: beezUPCommonDocUrl.optional(), description: z.string().optional(), href: beezUPCommonHref, operationId: beezUPCommonOperationId.optional(), method: beezUPCommonHttpMethod.optional(), parameters: z.record(z.string(), beezUPCommonLinkParameter3).optional(), urlTemplated: z.boolean().optional(), allRequiredParamsProvided: z.boolean().optional(), allOptionalParamsProvided: z.boolean().optional(), info: beezUPCommonInfoSummaries.optional()}); export const linksReenableChannelCatalogCategoryMappingLink = z.object({label: z.string().optional(), docUrl: beezUPCommonDocUrl.optional(), description: z.string().optional(), href: beezUPCommonHref, operationId: beezUPCommonOperationId.optional(), method: beezUPCommonHttpMethod.optional(), parameters: z.record(z.string(), beezUPCommonLinkParameter3).optional(), urlTemplated: z.boolean().optional(), allRequiredParamsProvided: z.boolean().optional(), allOptionalParamsProvided: z.boolean().optional(), info: beezUPCommonInfoSummaries.optional()}); export const linksDisableChannelCatalogCategoryMappingLink = z.object({label: z.string().optional(), docUrl: beezUPCommonDocUrl.optional(), description: z.string().optional(), href: beezUPCommonHref, operationId: beezUPCommonOperationId.optional(), method: beezUPCommonHttpMethod.optional(), parameters: z.record(z.string(), beezUPCommonLinkParameter3).optional(), urlTemplated: z.boolean().optional(), allRequiredParamsProvided: z.boolean().optional(), allOptionalParamsProvided: z.boolean().optional(), info: beezUPCommonInfoSummaries.optional()}); export const linksGetChannelCatalogCategoriesLink = z.object({label: z.string().optional(), docUrl: beezUPCommonDocUrl.optional(), description: z.string().optional(), href: beezUPCommonHref, operationId: beezUPCommonOperationId.optional(), method: beezUPCommonHttpMethod.optional(), parameters: z.record(z.string(), beezUPCommonLinkParameter3).optional(), urlTemplated: z.boolean().optional(), allRequiredParamsProvided: z.boolean().optional(), allOptionalParamsProvided: z.boolean().optional(), info: beezUPCommonInfoSummaries.optional()}); export const linksGetChannelCatalogExclusionFiltersLink = z.object({label: z.string().optional(), docUrl: beezUPCommonDocUrl.optional(), description: z.string().optional(), href: beezUPCommonHref, operationId: beezUPCommonOperationId.optional(), method: beezUPCommonHttpMethod.optional(), parameters: z.record(z.string(), beezUPCommonLinkParameter3).optional(), urlTemplated: z.boolean().optional(), allRequiredParamsProvided: z.boolean().optional(), allOptionalParamsProvided: z.boolean().optional(), info: beezUPCommonInfoSummaries.optional()}); export const linksGetChannelCatalogProductInfoListLink = z.object({label: z.string().optional(), docUrl: beezUPCommonDocUrl.optional(), description: z.string().optional(), href: beezUPCommonHref, operationId: beezUPCommonOperationId.optional(), method: beezUPCommonHttpMethod.optional(), parameters: z.record(z.string(), beezUPCommonLinkParameter3).optional(), urlTemplated: z.boolean().optional(), allRequiredParamsProvided: z.boolean().optional(), allOptionalParamsProvided: z.boolean().optional(), info: beezUPCommonInfoSummaries.optional()}); export const linksGetChannelCatalogExportationCacheInfoLink = z.object({label: z.string().optional(), docUrl: beezUPCommonDocUrl.optional(), description: z.string().optional(), href: beezUPCommonHref, operationId: beezUPCommonOperationId.optional(), method: beezUPCommonHttpMethod.optional(), parameters: z.record(z.string(), beezUPCommonLinkParameter3).optional(), urlTemplated: z.boolean().optional(), allRequiredParamsProvided: z.boolean().optional(), allOptionalParamsProvided: z.boolean().optional(), info: beezUPCommonInfoSummaries.optional()}); export const externalLinksGetChannelCatalogMarketplaceSettingsLink = z.object({label: z.string().optional(), docUrl: beezUPCommonDocUrl.optional(), description: z.string().optional(), href: beezUPCommonHref, operationId: beezUPCommonOperationId.optional(), method: beezUPCommonHttpMethod.optional(), parameters: z.record(z.string(), beezUPCommonLinkParameter3).optional(), urlTemplated: z.boolean().optional(), allRequiredParamsProvided: z.boolean().optional(), allOptionalParamsProvided: z.boolean().optional(), info: beezUPCommonInfoSummaries.optional()}); export const externalLinksGetChannelInfoLink = z.object({label: z.string().optional(), docUrl: beezUPCommonDocUrl.optional(), description: z.string().optional(), href: beezUPCommonHref, operationId: beezUPCommonOperationId.optional(), method: beezUPCommonHttpMethod.optional(), parameters: z.record(z.string(), beezUPCommonLinkParameter3).optional(), urlTemplated: z.boolean().optional(), allRequiredParamsProvided: z.boolean().optional(), allOptionalParamsProvided: z.boolean().optional(), info: beezUPCommonInfoSummaries.optional()}); export const channelCatalogLinks = z.object({self: linksGetChannelCatalogLink, delete: linksDeleteChannelCatalogLink.optional(), enable: linksEnableChannelCatalogLink.optional(), disable: linksDisableChannelCatalogLink.optional(), configureGeneralSettings: linksConfigureChannelCatalogGeneralSettingsLink.optional(), configureCostSettings: linksConfigureChannelCatalogCostSettingsLink.optional(), configureColumnMappings: linksConfigureChannelCatalogColumnMappingsLink.optional(), reenableCategoryMappings: linksReenableChannelCatalogCategoryMappingLink.optional(), disableCategoryMappings: linksDisableChannelCatalogCategoryMappingLink.optional(), categoryMappings: linksGetChannelCatalogCategoriesLink.optional(), exclusionFilters: linksGetChannelCatalogExclusionFiltersLink.optional(), products: linksGetChannelCatalogProductInfoListLink.optional(), exportationCacheInfo: linksGetChannelCatalogExportationCacheInfoLink.optional(), marketplaceSettings: externalLinksGetChannelCatalogMarketplaceSettingsLink.optional(), channelInfo: externalLinksGetChannelInfoLink.optional()}); export const channelCatalog = z.object({channelId: beezUPCommonChannelId, channelName: beezUPCommonChannelName, channelImageUrl: beezUPCommonHttpUrl, enabled: z.boolean(), isMarketplace: z.boolean(), channelCatalogId: beezUPCommonChannelCatalogId, storeId: beezUPCommonStoreId, generalSettings: generalSettings, channelCostSettings: channelCostSettings, channelCategorySettings: channelCategorySettings, costSettings: costSettings.optional(), categoryMappingSettings: channelCatalogCategoryMappingSettings.optional(), columnMappings: channelCatalogColumnMappingListWithName.optional(), exclusionFilters: exclusionFilters.optional(), exportUrl: beezUPCommonHttpUrl.optional(), state: channelCatalogState, types: z.array(z.string()), links: channelCatalogLinks}); export const channelCatalogList = z.object({links: channelCatalogListLinks.optional(), lovLinks: channelCatalogListLovLinks.optional(), channelCatalogs: z.record(z.string(), channelCatalog).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 }; /** * List all your current channel catalogs * * GET /v2/user/channelCatalogs/ */ export const getApiV2UserChannelCatalogs = async (args: GetApiV2UserChannelCatalogsArgs, options?: GetApiV2UserChannelCatalogsOptions) => { const {baseUrl = "https://api.beezup.com", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.storeId != null) query.append("storeId", String(args.storeId)) const url = `${baseUrl.replace(/\/+$/, '')}/v2/user/channelCatalogs/${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(channelCatalogList, await res.json()) };