import {z} from 'zod' export type GetApiAdminCheckoutsJsonArgs = {page?: number | undefined, limit?: number | undefined, email_statuses?: string | undefined, sms_statuses?: string | undefined, recovery_statuses?: string | undefined, search?: string | undefined}; export type GetApiAdminCheckoutsJsonOptions = {baseUrl?: string | undefined, APPACCESSTOKEN?: string | undefined, fetch?: typeof fetch | undefined}; export const customerAddressDetail = z.object({address1: z.string().optional(), address2: z.string().optional(), city: z.string().optional(), company: z.string().optional(), country: z.string().optional(), country_code: z.string().optional(), country_id: z.number().int().optional(), country_name: z.string().optional(), cpf_number: z.string().optional(), cpf_or_cnpj_number: z.string().optional(), created_at: z.string().optional(), default: z.boolean().optional(), first_name: z.string().optional(), id: z.number().int().optional(), last_name: z.string().optional(), latitude: z.number().optional(), longitude: z.number().optional(), name: z.string().optional(), phone: z.string().optional(), province: z.string().optional(), province_code: z.string().optional(), updated_at: z.string().optional(), zip: z.string().optional()}); export const checkoutDetailPaidInfo = z.object({discount_code: z.string().optional(), discount_total: z.number().optional(), shipping_fee: z.number().optional(), shipping_name: z.string().optional(), subtotal_price: z.number().optional(), tax_total: z.number().optional(), total_price: z.number().optional()}); export const customerDto = z.object({accepts_marketing: z.boolean().optional(), addresses: z.array(customerAddressDetail).optional(), average_spent: z.number().optional(), created_at: z.string().optional(), currency: z.string().optional(), default_address: customerAddressDetail.optional(), email: z.string().optional(), first_name: z.string().optional(), id: z.number().int().optional(), last_name: z.string().optional(), last_order_at: z.string().optional(), last_order_id: z.number().int().optional(), last_order_name: z.string().optional(), last_sent_abandoned_email_at: z.string().optional(), note: z.string().optional(), orders_count: z.number().int().optional(), phone: z.string().optional(), state: z.string().optional(), tags: z.string().optional(), tax_exempt: z.boolean().optional(), total_spent: z.number().optional(), updated_at: z.string().optional(), verified_email: z.boolean().optional()}); export const discountApplication = z.object({allocation_method: z.string().optional(), amount: z.number().optional(), code: z.string().optional(), discount_type: z.string().optional(), is_valid: z.boolean().optional(), price_rule_id: z.number().int().optional(), price_rule_title: z.string().optional(), price_rule_type: z.string().optional(), scope: z.string().optional(), type: z.string().optional(), value: z.number().optional(), value_type: z.string().optional()}); export const orderLineItemDiscountApplicationDto = z.object({amount: z.number().optional(), discount_application_index: z.number().int().optional()}); export const lineItemShippingRate = z.object({code: z.string().optional(), id: z.number().int().optional(), is_post_purchase: z.boolean().optional(), price: z.number().optional(), title: z.string().optional(), type: z.string().optional(), variant_id: z.number().int().optional()}); export const taxLineDto = z.object({price: z.number().optional(), rate: z.number().optional(), title: z.string().optional()}); export const orderLineItemDto = z.object({discount_allocations: z.array(orderLineItemDiscountApplicationDto).optional(), discount_amount: z.number().optional(), fulfillable_quantity: z.number().int().optional(), fulfillment_service: z.string().optional(), fulfillment_status: z.string().optional(), gift_card: z.boolean().optional(), image_src: z.string().optional(), is_post_purchase_item: z.boolean().optional(), item_discount_price: z.number().optional(), line_item_discount_amount: z.number().optional(), line_item_discount_price: z.number().optional(), line_item_price: z.number().optional(), line_item_price_after_discount: z.number().optional(), line_item_price_before_discount: z.number().optional(), line_item_price_with_explicit_discount: z.number().optional(), line_item_weight: z.number().optional(), name: z.string().optional(), not_explicit_discount_price: z.number().optional(), order_id: z.number().int().optional(), price: z.number().optional(), product_id: z.number().int().optional(), product_is_deleted: z.boolean().optional(), product_type: z.string().optional(), properties: z.array(z.unknown()).optional(), quantity: z.number().optional(), raw_price: z.number().optional(), raw_weight: z.number().optional(), requires_shipping: z.boolean().optional(), shipping_rate: lineItemShippingRate.optional(), sku: z.string().optional(), tags: z.string().optional(), tax_amount: z.number().optional(), tax_lines: z.array(taxLineDto).optional(), tax_rate: z.number().optional(), taxable: z.boolean().optional(), tip_payment_gateway: z.string().optional(), tip_payment_method: z.string().optional(), title: z.string().optional(), total_discount: z.number().optional(), total_item_discount_price: z.number().optional(), total_line_with_discount_price: z.number().optional(), total_tax_amount: z.number().optional(), variant_id: z.number().int().optional(), variant_title: z.string().optional(), vendor: z.string().optional(), weight: z.number().optional(), weight_unit: z.string().optional()}); export const filterRule = z.object({column: z.string().optional(), condition: z.string().optional(), relation: z.string().optional()}); export const itemBasedShippingRateDto = z.object({additional_item_price: z.number().optional(), created_at: z.number().int().optional(), exclude_rules: z.array(filterRule).optional(), first_item_price: z.number().optional(), group_tag: z.string().optional(), id: z.number().int().optional(), name: z.string().optional(), price_unit: z.string().optional(), rules: z.array(filterRule).optional(), shipping_zone_id: z.number().int().optional(), shop_id: z.number().int().optional(), updated_at: z.number().int().optional()}); export const priceBasedShippingRateDto = z.object({created_at: z.number().int().optional(), free_ship: z.boolean().optional(), id: z.number().int().optional(), max_order_subtotal: z.number().optional(), min_order_subtotal: z.number().optional(), name: z.string().optional(), order_subtotal_unit: z.string().optional(), price: z.number().optional(), price_unit: z.string().optional(), shipping_zone_id: z.number().int().optional(), shop_id: z.number().int().optional(), updated_at: z.number().int().optional()}); export const weightBasedShippingRateDto = z.object({created_at: z.number().int().optional(), id: z.number().int().optional(), name: z.string().optional(), price: z.number().optional(), price_unit: z.string().optional(), shipping_zone_id: z.number().int().optional(), shop_id: z.number().int().optional(), updated_at: z.number().int().optional(), weight_high: z.number().optional(), weight_low: z.number().optional(), weight_unit: z.string().optional()}); export const shippingRateDto = z.object({item_based: itemBasedShippingRateDto.optional(), price_based: priceBasedShippingRateDto.optional(), profile_id: z.number().int().optional(), weight_based: weightBasedShippingRateDto.optional()}); export const shippingRate = z.object({cart_item_id: z.number().int().optional(), code: z.string().optional(), id: z.number().int().optional(), is_post_purchase: z.boolean().optional(), price: z.number().optional(), raw: shippingRateDto.optional(), title: z.string().optional(), type: z.string().optional(), variant_id: z.number().int().optional()}); export const shippingMethod = z.object({carrier_code: z.string().optional(), discount_amount: z.number().optional(), discounted_price: z.number().optional(), method_code: z.string().optional(), method_title: z.string().optional(), price: z.number().optional(), shipping_rates: z.array(shippingRate).optional(), shipping_rule_id: z.number().int().optional(), shipping_rule_type: z.string().optional()}); export const abandonedCheckoutDto = z.object({abandoned_at: z.string().optional(), abandoned_checkout_url: z.string().optional(), abandoned_email_status: z.string().optional(), abandoned_sms_status: z.string().optional(), billing_address: customerAddressDetail.optional(), billing_address_same_as_shipping_address: z.boolean().optional(), buyer_accepts_marketing: z.boolean().optional(), cart_token: z.string().optional(), checkout_detail_paid_info: checkoutDetailPaidInfo.optional(), completed_at: z.string().optional(), created_at: z.string().optional(), currency: z.string().optional(), customer: customerDto.optional(), discount_applications: z.array(discountApplication).optional(), discount_applied: z.boolean().optional(), discount_price: z.number().optional(), email: z.string().optional(), gateway: z.string().optional(), id: z.number().int().optional(), line_items: z.array(orderLineItemDto).optional(), lock_send_email_reason: z.string().optional(), name: z.string().optional(), note: z.string().optional(), phone: z.string().optional(), real_sent_at: z.string().optional(), recovery_email_sent: z.boolean().optional(), scheduled_sent_at: z.string().optional(), shipping_address: customerAddressDetail.optional(), shipping_discount: z.number().optional(), shipping_fee: z.number().optional(), shipping_method: shippingMethod.optional(), shipping_name: z.string().optional(), shipping_price: z.number().optional(), shipping_tax: z.number().optional(), shop_id: z.number().int().optional(), subtotal_price: z.number().optional(), taxes_included: z.boolean().optional(), token: z.string().optional(), total_discounts: z.number().optional(), total_line_items_price: z.number().optional(), total_price: z.number().optional(), total_shipping: z.number().optional(), total_tax: z.number().optional(), total_weight: z.number().optional(), updated_at: z.string().optional()}); export const abandonedCheckoutsSwaggerResponse = z.object({checkouts: z.array(abandonedCheckoutDto).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 }; /** * Retrieve a list of abandoned checkouts * * GET /admin/checkouts.json */ export const getApiAdminCheckoutsJson = async (args: GetApiAdminCheckoutsJsonArgs, options?: GetApiAdminCheckoutsJsonOptions) => { const {baseUrl = "https://shop-name.onshopbase.com", fetch: fetchFn = fetch, APPACCESSTOKEN} = 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.limit != null) query.append("limit", String(args.limit)) if (args.email_statuses != null) query.append("email_statuses", String(args.email_statuses)) if (args.sms_statuses != null) query.append("sms_statuses", String(args.sms_statuses)) if (args.recovery_statuses != null) query.append("recovery_statuses", String(args.recovery_statuses)) if (args.search != null) query.append("search", String(args.search)) if (APPACCESSTOKEN !== undefined) headers.set("APP_ACCESS_TOKEN", APPACCESSTOKEN) const url = `${baseUrl.replace(/\/+$/, '')}/admin/checkouts.json${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(abandonedCheckoutsSwaggerResponse, await res.json()) };