import {z} from 'zod' export type GetApiShopsSHOPIDAdsManagerCampaignsV2Args = {SHOP_ID: number, page?: number | undefined, page_size?: number | undefined, start_time?: number | undefined, end_time?: number | undefined, select_fields?: string | undefined}; export type GetApiShopsSHOPIDAdsManagerCampaignsV2Options = {baseUrl?: string | undefined, ApiKeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const retailPriceByCurrency = z.object({currency: z.string(), retailPriceByCurrency: z.union([z.number(), z.string()])}); export const variationSize = z.object({length: z.number().int().optional(), width: z.number().int().optional(), height: z.number().int().optional()}); export const variationWarehouse = z.object({id: z.string().optional(), variation_id: z.string().optional(), warehouse_id: z.string().optional(), shop_id: z.number().int().optional(), remain_quantity: z.number().int().optional(), available_quantity: z.number().int().optional(), actual_remain_quantity: z.number().int().optional(), total_quantity: z.number().int().optional(), waitting_quantity: z.number().int().optional(), pending_quantity: z.number().int().optional(), transfer_quantity: z.number().int().optional(), pending_transfer_quantity: z.number().int().optional(), pending_export_quantity: z.number().int().optional(), shipping_quantity: z.number().int().optional(), returning_quantity: z.number().int().optional(), defect_quantity: z.number().int().optional(), total_quantity_transfer: z.number().int().optional(), shelf_quantity: z.number().int().optional(), quantity_in_batch: z.number().int().optional(), batch_position: z.string().nullable().optional(), shelf_position: z.string().nullable().optional(), selling_status: z.enum(["none", "bad", "normal", "star"]).optional(), selling_avg: z.number().optional(), avg_price: z.number().optional(), nearly_out: z.boolean().optional(), not_permission_view_quantity: z.boolean().nullable().optional()}); export const variation = z.object({id: z.string().optional(), fields: z.array(z.object({name: z.string().optional(), value: z.string().optional()})).optional(), images: z.array(z.string()).optional(), last_imported_price: z.number().int().optional(), retail_price: z.number().int().optional(), price_at_counter: z.number().int().optional(), retail_price_by_currency: z.array(retailPriceByCurrency).optional(), weight: z.number().int().optional(), size: variationSize.optional(), barcode: z.string().optional(), custom_id: z.string().optional(), is_hidden: z.boolean().optional(), variations_warehouses: z.array(variationWarehouse).optional(), wholesale_price2: z.array(z.object({levelProduct: z.string().optional(), wholesalePrices: z.string().optional()})).optional(), is_removed: z.boolean().optional(), keyword: z.string().optional()}); export const product = z.object({measure_group_id: z.number().int().optional(), name: z.string(), einvoice_name: z.string().max(255).nullable().optional(), type: z.enum(["product", "accessory", "service", "LOT"]).optional(), category_ids: z.array(z.number().int()).optional(), note: z.string().optional(), note_product: z.string().optional(), product_attributes: z.array(z.object({name: z.string().optional(), values: z.array(z.string()).optional()})).optional(), tags: z.array(z.number().int()).optional(), weight: z.number().int(), custom_id: z.string().optional(), is_published: z.boolean().optional(), variations: z.array(variation).optional(), bonus_products: z.array(z.object({quantity: z.number().int(), variation_id: z.string(), price_original: z.number().int(), images: z.array(z.string()).optional(), variation_info: z.object({id: z.string(), measure_group_id: z.string().optional(), measure_info: z.object({exchange_value: z.number().int().optional(), measure_id: z.number().int().optional()}).optional(), name: z.string(), product_id: z.string(), weight: z.number().int().optional()})})).optional(), materials: z.array(z.number().int()).optional(), keyword: z.string().optional(), brand_id: z.string().optional()}); export const campaignListResponse = z.object({success: z.boolean().optional(), data: z.array(z.object({id: z.string().optional(), name: z.string().optional(), status: z.enum(["ACTIVE", "PAUSED", "DELETED", "ARCHIVED"]).optional(), effective_status: z.enum(["ACTIVE", "PAUSED", "DELETED", "ARCHIVED", "IN_PROCESS", "WITH_ISSUES"]).optional(), objective: z.enum(["APP_INSTALLS", "BRAND_AWARENESS", "CONVERSIONS", "EVENT_RESPONSES", "LEAD_GENERATION", "LINK_CLICKS", "LOCAL_AWARENESS", "MESSAGES", "OFFER_CLAIMS", "OUTCOME_APP_PROMOTION", "OUTCOME_AWARENESS", "OUTCOME_ENGAGEMENT", "OUTCOME_LEADS", "OUTCOME_SALES", "OUTCOME_TRAFFIC", "PAGE_LIKES", "POST_ENGAGEMENT", "PRODUCT_CATALOG_SALES", "REACH", "STORE_VISITS", "VIDEO_VIEWS"]).optional(), created_time: z.string().optional(), start_time: z.string().optional(), end_time: z.string().nullable().optional(), marketer_id: z.string().nullable().optional(), product_id: z.string().nullable().optional(), product_category_id: z.string().nullable().optional(), product: product.nullable().optional(), ad_account: z.object({id: z.string().optional(), name: z.string().optional(), currency: z.string().optional()}).optional(), insights: z.object({ad_ids: z.array(z.string()).optional(), impressions: z.number().optional(), clicks: z.number().int().optional(), reach: z.number().int().optional(), spend: z.number().optional(), cpc: z.number().optional(), cpm: z.number().optional(), cpp: z.number().optional(), ctr: z.number().optional(), frequency: z.number().optional(), ad_performance_session: z.number().int().optional(), cost_per_1000_accounts_center_reach: z.number().optional(), cost_per_result: z.number().optional(), avg_purchase_conversion_value: z.number().optional(), indicator_result: z.number().optional(), result_roas: z.number().optional(), ad_engagement_session: z.number().int().optional(), link_click: z.number().int().optional(), like: z.number().int().optional(), comment: z.number().int().optional(), post_engagement: z.number().int().optional(), post_reaction: z.number().int().optional(), post: z.number().int().optional(), onsite_conversion_post_save: z.number().int().optional(), photo_view: z.number().int().optional(), video_view: z.number().int().optional(), inline_link_click_ctr: z.number().optional(), outbound_click: z.number().int().optional(), onsite_conversion_messaging_conversation_started_7d: z.number().int().optional(), onsite_conversion_messaging_first_reply: z.number().int().optional(), onsite_conversion_messaging_block: z.number().int().optional(), video_thruplay_watched_actions: z.number().int().optional(), video_play_actions: z.number().int().optional(), video_p25_watched_actions: z.number().int().optional(), video_p50_watched_actions: z.number().int().optional(), video_p75_watched_actions: z.number().int().optional(), video_p95_watched_actions: z.number().int().optional(), video_p100_watched_actions: z.number().int().optional(), estimated_ad_recallers: z.number().optional(), cost_per_outbound_click: z.number().optional(), cost_per_thruplay: z.number().optional(), outbound_clicks_ctr: z.number().optional(), cost_per_post_engagement: z.number().optional(), estimated_ad_recall_rate: z.number().optional(), cost_per_estimated_ad_recallers: z.number().optional(), cost_per_messaging_conversation_started: z.number().optional(), lead: z.number().optional(), website_lead: z.number().optional(), offline_lead: z.number().optional(), meta_lead: z.number().optional(), lead_conversion_value: z.number().optional(), website_lead_conversion_value: z.number().optional(), offline_lead_conversion_value: z.number().optional(), meta_lead_conversion_value: z.number().optional(), cost_per_lead: z.number().optional(), omni_purchase: z.number().optional(), inapp_omni_purchase: z.number().optional(), website_omni_purchase: z.number().optional(), offline_omni_purchase: z.number().optional(), meta_omni_purchase: z.number().optional(), omni_purchase_conversion_value: z.number().optional(), inapp_omni_purchase_conversion_value: z.number().optional(), website_omni_purchase_conversion_value: z.number().optional(), offline_omni_purchase_conversion_value: z.number().optional(), meta_omni_purchase_conversion_value: z.number().optional(), cost_per_omni_purchase: z.number().optional(), omni_initiated_checkout: z.number().optional(), inapp_omni_initiated_checkout: z.number().optional(), website_omni_initiated_checkout: z.number().optional(), offline_omni_initiated_checkout: z.number().optional(), meta_omni_initiated_checkout: z.number().optional(), omni_initiated_checkout_conversion_value: z.number().optional(), inapp_omni_initiated_checkout_conversion_value: z.number().optional(), website_omni_initiated_checkout_conversion_value: z.number().optional(), offline_omni_initiated_checkout_conversion_value: z.number().optional(), meta_omni_initiated_checkout_conversion_value: z.number().optional(), cost_per_omni_initiated_checkout: z.number().optional(), omni_complete_registration: z.number().optional(), inapp_omni_complete_registration: z.number().optional(), website_omni_complete_registration: z.number().optional(), offline_omni_complete_registration: z.number().optional(), omni_complete_registration_conversion_value: z.number().optional(), inapp_omni_complete_registration_conversion_value: z.number().optional(), website_omni_complete_registration_conversion_value: z.number().optional(), offline_omni_complete_registration_conversion_value: z.number().optional(), cost_per_omni_complete_registration: z.number().optional(), omni_view_content: z.number().optional(), inapp_omni_view_content: z.number().optional(), website_omni_view_content: z.number().optional(), offline_omni_view_content: z.number().optional(), meta_omni_view_content: z.number().optional(), omni_view_content_conversion_value: z.number().optional(), inapp_omni_view_content_conversion_value: z.number().optional(), website_omni_view_content_conversion_value: z.number().optional(), offline_omni_view_content_conversion_value: z.number().optional(), meta_omni_view_content_conversion_value: z.number().optional(), cost_per_omni_view_content: z.number().optional(), omni_search: z.number().optional(), inapp_omni_search: z.number().optional(), website_omni_search: z.number().optional(), offline_omni_search: z.number().optional(), omni_search_conversion_value: z.number().optional(), inapp_omni_search_conversion_value: z.number().optional(), website_omni_search_conversion_value: z.number().optional(), offline_omni_search_conversion_value: z.number().optional(), cost_per_omni_search: z.number().optional(), omni_add_to_cart: z.number().optional(), inapp_omni_add_to_cart: z.number().optional(), website_omni_add_to_cart: z.number().optional(), offline_omni_add_to_cart: z.number().optional(), meta_omni_add_to_cart: z.number().optional(), omni_add_to_cart_conversion_value: z.number().optional(), inapp_omni_add_to_cart_conversion_value: z.number().optional(), website_omni_add_to_cart_conversion_value: z.number().optional(), offline_omni_add_to_cart_conversion_value: z.number().optional(), meta_omni_add_to_cart_conversion_value: z.number().optional(), cost_per_omni_add_to_cart: z.number().optional(), omni_add_to_wishlist: z.number().optional(), inapp_omni_add_to_wishlist: z.number().optional(), website_omni_add_to_wishlist: z.number().optional(), offline_omni_add_to_wishlist: z.number().optional(), meta_omni_add_to_wishlist: z.number().optional(), omni_add_to_wishlist_conversion_value: z.number().optional(), inapp_omni_add_to_wishlist_conversion_value: z.number().optional(), website_omni_add_to_wishlist_conversion_value: z.number().optional(), offline_omni_add_to_wishlist_conversion_value: z.number().optional(), meta_omni_add_to_wishlist_conversion_value: z.number().optional(), cost_per_omni_add_to_wishlist: z.number().optional(), customize_product_total: z.number().optional(), inapp_customize_product_total: z.number().optional(), website_customize_product_total: z.number().optional(), offline_customize_product_total: z.number().optional(), customize_product_total_conversion_value: z.number().optional(), inapp_customize_product_total_conversion_value: z.number().optional(), website_customize_product_total_conversion_value: z.number().optional(), offline_customize_product_total_conversion_value: z.number().optional(), cost_per_customize_product_total: z.number().optional(), start_trial_total: z.number().optional(), inapp_start_trial_total: z.number().optional(), website_start_trial_total: z.number().optional(), offline_start_trial_total: z.number().optional(), start_trial_total_conversion_value: z.number().optional(), inapp_start_trial_total_conversion_value: z.number().optional(), website_start_trial_total_conversion_value: z.number().optional(), offline_start_trial_total_conversion_value: z.number().optional(), cost_per_start_trial_total: z.number().optional(), subscribe_total: z.number().optional(), inapp_subscribe_total: z.number().optional(), website_subscribe_total: z.number().optional(), offline_subscribe_total: z.number().optional(), subscribe_total_conversion_value: z.number().optional(), inapp_subscribe_total_conversion_value: z.number().optional(), website_subscribe_total_conversion_value: z.number().optional(), offline_subscribe_total_conversion_value: z.number().optional(), cost_per_subscribe_total: z.number().optional(), submit_application_total: z.number().optional(), inapp_submit_application_total: z.number().optional(), website_submit_application_total: z.number().optional(), offline_submit_application_total: z.number().optional(), meta_submit_application_total: z.number().optional(), submit_application_total_conversion_value: z.number().optional(), inapp_submit_application_total_conversion_value: z.number().optional(), website_submit_application_total_conversion_value: z.number().optional(), offline_submit_application_total_conversion_value: z.number().optional(), meta_submit_application_total_conversion_value: z.number().optional(), cost_per_submit_application_total: z.number().optional(), contact_total: z.number().optional(), inapp_contact_total: z.number().optional(), website_contact_total: z.number().optional(), offline_contact_total: z.number().optional(), contact_total_conversion_value: z.number().optional(), inapp_contact_total_conversion_value: z.number().optional(), website_contact_total_conversion_value: z.number().optional(), offline_contact_total_conversion_value: z.number().optional(), cost_per_contact_total: z.number().optional(), landing_page_view: z.number().optional(), inapp_landing_page_view: z.number().optional(), website_landing_page_view: z.number().optional(), cost_per_landing_page_view: z.number().optional(), order_created: z.number().optional(), order_shipped: z.number().optional(), purchase_roas: z.number().optional(), inapp_purchase_roas: z.number().optional(), website_purchase_roas: z.number().optional(), order_statistics: z.array(z.object({id: z.number().int().optional(), order_count: z.number().int().optional()})).optional()}).optional()})).optional(), summary: z.object({impressions: z.number().optional(), clicks: z.number().int().optional(), reach: z.number().int().optional(), spend: z.number().optional(), cpc: z.number().optional(), cpm: z.number().optional(), cpp: z.number().optional(), ctr: z.number().optional(), frequency: z.number().optional()}).optional(), page_number: z.number().int().optional(), page_size: z.number().int().optional(), total_entries: z.number().int().optional(), total_pages: z.number().int().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 of ad campaigns * * GET /shops/{SHOP_ID}/ads_manager/campaigns_v2 */ export const getApiShopsSHOPIDAdsManagerCampaignsV2 = async (args: GetApiShopsSHOPIDAdsManagerCampaignsV2Args, options?: GetApiShopsSHOPIDAdsManagerCampaignsV2Options) => { const {baseUrl = "https://pos.pages.fm/api/v1", fetch: fetchFn = fetch, ApiKeyAuth} = 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.page_size != null) query.append("page_size", String(args.page_size)) if (args.start_time != null) query.append("start_time", String(args.start_time)) if (args.end_time != null) query.append("end_time", String(args.end_time)) if (args.select_fields != null) query.append("select_fields", String(args.select_fields)) if (ApiKeyAuth !== undefined) query.set("api_key", ApiKeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/shops/${encodeURIComponent(String(args.SHOP_ID))}/ads_manager/campaigns_v2${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(campaignListResponse, await res.json()) };