@ecomiq/core 0.1.8 → 1.0.0

package/dist/services/checkout.service.d.cts

@@ -0,0 +1,439 @@
+import { Api } from "../api.cjs";
+import { CustomerRequestOptions } from "./customer.service.cjs";
+import { StorefrontCart } from "../models/storefront-cart.cjs";
+import { CartAddressesParams, CartBuyerParams, CartCheckoutParams, CartCheckoutReadParams, CartCheckoutReadResponse, CartCheckoutResponse, CartPaymentReceiptResponse, CartPromotionCodeParams, GetShippingOptionsParams, PutCartPaymentMethodParams, PutShippingMethodParams, ShippingOptionsResponse, UploadPaymentReceiptParams } from "../models/storefront-checkout.cjs";
+/** GET /v1/carts/{cartToken}/checkout */
+export declare function getCartCheckout(api: Api, params: CartCheckoutReadParams): Promise<CartCheckoutReadResponse>;
+/** GET /v1/carts/{cartToken}/shipping-options?postalCode= */
+export declare function getShippingOptions(api: Api, params: GetShippingOptionsParams): Promise<ShippingOptionsResponse>;
+/** PUT /v1/carts/{cartToken}/shipping-method */
+export declare function putCartShippingMethod(api: Api, params: PutShippingMethodParams): Promise<{
+  id: string;
+  token: string;
+  cartNumber: string;
+  email: string | null;
+  phone: string | null;
+  firstName: string | null;
+  lastName: string | null;
+  currencyCode: string;
+  status: "abandoned" | "cancelled" | "completed" | "expired" | "failed" | "inProgress" | "pending";
+  completedAt: string | null;
+  shippingAddress: {
+    name: string | null;
+    address1: string;
+    city: string;
+    countryCode: string;
+    company: string | null;
+    address2: string | null;
+    department?: string | null | undefined;
+    province: string | null;
+    postalCode: string | null;
+    district: string | null;
+    phone: string | null;
+    latitude: number | null;
+    longitude: number | null;
+  } | null;
+  billingAddress: {
+    name: string | null;
+    address1: string;
+    city: string;
+    countryCode: string;
+    company: string | null;
+    address2: string | null;
+    department?: string | null | undefined;
+    province: string | null;
+    postalCode: string | null;
+    district: string | null;
+    phone: string | null;
+    latitude: number | null;
+    longitude: number | null;
+  } | null;
+  promotionCodes: string[];
+  items: {
+    id: string;
+    productId: string | null;
+    title: string;
+    variantLabel: string | null;
+    productHandle: string | null;
+    productUrl: string | null;
+    thumbnail: string | null;
+    quantity: number;
+    variantId: string | null;
+    variantSku: string | null;
+    unitPrice: number;
+    compareAtUnitPrice: number | null;
+    bundleItems: {
+      productId: string;
+      variantId: string;
+      productName: string;
+      variantName: string | null;
+      sku: string | null;
+      brand: string | null;
+      imageUrl: string | null;
+      quantity: number;
+    }[];
+    requiresShipping: boolean;
+    sellerId: string | null;
+    sellerName: string | null;
+    orderBumpId: string | null;
+  }[];
+  shippingMethods: {
+    id: string;
+    shippingMethodId: string | null;
+    rateId: string | null;
+    name: string;
+    description: string | null;
+    type: "express" | "localDelivery" | "pickup" | "regular" | "sameDay";
+    target: "automatic" | "location" | "pickupPoint";
+    targetId: string | null;
+    fulfillmentLocationId: string | null;
+    total: number;
+    estimatedDays: number | null;
+    scheduledDate: string | null;
+    scheduledTime: string | null;
+    serviceCode: string | null;
+    sellerId: string | null;
+    shippingProfileId: string | null;
+  }[];
+  paymentMethodCode: string | null;
+  totals: {
+    subtotal: number;
+    discountTotal: number;
+    shippingOriginalTotal: number;
+    shippingTotal: number;
+    taxTotal: number;
+    warrantyTotal: number;
+    total: number;
+  };
+  invoiceType: "invoice" | "receipt" | "ticket";
+  identificationType: string | null;
+  identificationCountryCode?: string | null | undefined;
+  identificationNumber: string | null;
+  entityTaxId: string | null;
+  entityName: string | null;
+}>;
+export declare function putCartPaymentMethod(api: Api, params: PutCartPaymentMethodParams): Promise<StorefrontCart>;
+/** PATCH /v1/carts/{cartToken}/buyer */
+export declare function patchCartBuyer(api: Api, params: CartBuyerParams): Promise<{
+  id: string;
+  token: string;
+  cartNumber: string;
+  email: string | null;
+  phone: string | null;
+  firstName: string | null;
+  lastName: string | null;
+  currencyCode: string;
+  status: "abandoned" | "cancelled" | "completed" | "expired" | "failed" | "inProgress" | "pending";
+  completedAt: string | null;
+  shippingAddress: {
+    name: string | null;
+    address1: string;
+    city: string;
+    countryCode: string;
+    company: string | null;
+    address2: string | null;
+    department?: string | null | undefined;
+    province: string | null;
+    postalCode: string | null;
+    district: string | null;
+    phone: string | null;
+    latitude: number | null;
+    longitude: number | null;
+  } | null;
+  billingAddress: {
+    name: string | null;
+    address1: string;
+    city: string;
+    countryCode: string;
+    company: string | null;
+    address2: string | null;
+    department?: string | null | undefined;
+    province: string | null;
+    postalCode: string | null;
+    district: string | null;
+    phone: string | null;
+    latitude: number | null;
+    longitude: number | null;
+  } | null;
+  promotionCodes: string[];
+  items: {
+    id: string;
+    productId: string | null;
+    title: string;
+    variantLabel: string | null;
+    productHandle: string | null;
+    productUrl: string | null;
+    thumbnail: string | null;
+    quantity: number;
+    variantId: string | null;
+    variantSku: string | null;
+    unitPrice: number;
+    compareAtUnitPrice: number | null;
+    bundleItems: {
+      productId: string;
+      variantId: string;
+      productName: string;
+      variantName: string | null;
+      sku: string | null;
+      brand: string | null;
+      imageUrl: string | null;
+      quantity: number;
+    }[];
+    requiresShipping: boolean;
+    sellerId: string | null;
+    sellerName: string | null;
+    orderBumpId: string | null;
+  }[];
+  shippingMethods: {
+    id: string;
+    shippingMethodId: string | null;
+    rateId: string | null;
+    name: string;
+    description: string | null;
+    type: "express" | "localDelivery" | "pickup" | "regular" | "sameDay";
+    target: "automatic" | "location" | "pickupPoint";
+    targetId: string | null;
+    fulfillmentLocationId: string | null;
+    total: number;
+    estimatedDays: number | null;
+    scheduledDate: string | null;
+    scheduledTime: string | null;
+    serviceCode: string | null;
+    sellerId: string | null;
+    shippingProfileId: string | null;
+  }[];
+  paymentMethodCode: string | null;
+  totals: {
+    subtotal: number;
+    discountTotal: number;
+    shippingOriginalTotal: number;
+    shippingTotal: number;
+    taxTotal: number;
+    warrantyTotal: number;
+    total: number;
+  };
+  invoiceType: "invoice" | "receipt" | "ticket";
+  identificationType: string | null;
+  identificationCountryCode?: string | null | undefined;
+  identificationNumber: string | null;
+  entityTaxId: string | null;
+  entityName: string | null;
+}>;
+/** PATCH /v1/carts/{cartToken}/addresses */
+export declare function patchCartAddresses(api: Api, params: CartAddressesParams): Promise<StorefrontCart>;
+/** POST /v1/carts/{cartToken}/checkout */
+export declare function checkoutCart(api: Api, params: CartCheckoutParams, options?: CustomerRequestOptions): Promise<CartCheckoutResponse>;
+/** POST /v1/carts/{cartToken}/payment-receipt (multipart) */
+export declare function uploadPaymentReceipt(api: Api, params: UploadPaymentReceiptParams): Promise<CartPaymentReceiptResponse>;
+/** POST /v1/carts/{cartToken}/promotion-codes */
+export declare function addCartPromotionCode(api: Api, params: CartPromotionCodeParams): Promise<{
+  id: string;
+  token: string;
+  cartNumber: string;
+  email: string | null;
+  phone: string | null;
+  firstName: string | null;
+  lastName: string | null;
+  currencyCode: string;
+  status: "abandoned" | "cancelled" | "completed" | "expired" | "failed" | "inProgress" | "pending";
+  completedAt: string | null;
+  shippingAddress: {
+    name: string | null;
+    address1: string;
+    city: string;
+    countryCode: string;
+    company: string | null;
+    address2: string | null;
+    department?: string | null | undefined;
+    province: string | null;
+    postalCode: string | null;
+    district: string | null;
+    phone: string | null;
+    latitude: number | null;
+    longitude: number | null;
+  } | null;
+  billingAddress: {
+    name: string | null;
+    address1: string;
+    city: string;
+    countryCode: string;
+    company: string | null;
+    address2: string | null;
+    department?: string | null | undefined;
+    province: string | null;
+    postalCode: string | null;
+    district: string | null;
+    phone: string | null;
+    latitude: number | null;
+    longitude: number | null;
+  } | null;
+  promotionCodes: string[];
+  items: {
+    id: string;
+    productId: string | null;
+    title: string;
+    variantLabel: string | null;
+    productHandle: string | null;
+    productUrl: string | null;
+    thumbnail: string | null;
+    quantity: number;
+    variantId: string | null;
+    variantSku: string | null;
+    unitPrice: number;
+    compareAtUnitPrice: number | null;
+    bundleItems: {
+      productId: string;
+      variantId: string;
+      productName: string;
+      variantName: string | null;
+      sku: string | null;
+      brand: string | null;
+      imageUrl: string | null;
+      quantity: number;
+    }[];
+    requiresShipping: boolean;
+    sellerId: string | null;
+    sellerName: string | null;
+    orderBumpId: string | null;
+  }[];
+  shippingMethods: {
+    id: string;
+    shippingMethodId: string | null;
+    rateId: string | null;
+    name: string;
+    description: string | null;
+    type: "express" | "localDelivery" | "pickup" | "regular" | "sameDay";
+    target: "automatic" | "location" | "pickupPoint";
+    targetId: string | null;
+    fulfillmentLocationId: string | null;
+    total: number;
+    estimatedDays: number | null;
+    scheduledDate: string | null;
+    scheduledTime: string | null;
+    serviceCode: string | null;
+    sellerId: string | null;
+    shippingProfileId: string | null;
+  }[];
+  paymentMethodCode: string | null;
+  totals: {
+    subtotal: number;
+    discountTotal: number;
+    shippingOriginalTotal: number;
+    shippingTotal: number;
+    taxTotal: number;
+    warrantyTotal: number;
+    total: number;
+  };
+  invoiceType: "invoice" | "receipt" | "ticket";
+  identificationType: string | null;
+  identificationCountryCode?: string | null | undefined;
+  identificationNumber: string | null;
+  entityTaxId: string | null;
+  entityName: string | null;
+}>;
+/** DELETE /v1/carts/{cartToken}/promotion-codes/{code} */
+export declare function removeCartPromotionCode(api: Api, params: CartPromotionCodeParams): Promise<{
+  id: string;
+  token: string;
+  cartNumber: string;
+  email: string | null;
+  phone: string | null;
+  firstName: string | null;
+  lastName: string | null;
+  currencyCode: string;
+  status: "abandoned" | "cancelled" | "completed" | "expired" | "failed" | "inProgress" | "pending";
+  completedAt: string | null;
+  shippingAddress: {
+    name: string | null;
+    address1: string;
+    city: string;
+    countryCode: string;
+    company: string | null;
+    address2: string | null;
+    department?: string | null | undefined;
+    province: string | null;
+    postalCode: string | null;
+    district: string | null;
+    phone: string | null;
+    latitude: number | null;
+    longitude: number | null;
+  } | null;
+  billingAddress: {
+    name: string | null;
+    address1: string;
+    city: string;
+    countryCode: string;
+    company: string | null;
+    address2: string | null;
+    department?: string | null | undefined;
+    province: string | null;
+    postalCode: string | null;
+    district: string | null;
+    phone: string | null;
+    latitude: number | null;
+    longitude: number | null;
+  } | null;
+  promotionCodes: string[];
+  items: {
+    id: string;
+    productId: string | null;
+    title: string;
+    variantLabel: string | null;
+    productHandle: string | null;
+    productUrl: string | null;
+    thumbnail: string | null;
+    quantity: number;
+    variantId: string | null;
+    variantSku: string | null;
+    unitPrice: number;
+    compareAtUnitPrice: number | null;
+    bundleItems: {
+      productId: string;
+      variantId: string;
+      productName: string;
+      variantName: string | null;
+      sku: string | null;
+      brand: string | null;
+      imageUrl: string | null;
+      quantity: number;
+    }[];
+    requiresShipping: boolean;
+    sellerId: string | null;
+    sellerName: string | null;
+    orderBumpId: string | null;
+  }[];
+  shippingMethods: {
+    id: string;
+    shippingMethodId: string | null;
+    rateId: string | null;
+    name: string;
+    description: string | null;
+    type: "express" | "localDelivery" | "pickup" | "regular" | "sameDay";
+    target: "automatic" | "location" | "pickupPoint";
+    targetId: string | null;
+    fulfillmentLocationId: string | null;
+    total: number;
+    estimatedDays: number | null;
+    scheduledDate: string | null;
+    scheduledTime: string | null;
+    serviceCode: string | null;
+    sellerId: string | null;
+    shippingProfileId: string | null;
+  }[];
+  paymentMethodCode: string | null;
+  totals: {
+    subtotal: number;
+    discountTotal: number;
+    shippingOriginalTotal: number;
+    shippingTotal: number;
+    taxTotal: number;
+    warrantyTotal: number;
+    total: number;
+  };
+  invoiceType: "invoice" | "receipt" | "ticket";
+  identificationType: string | null;
+  identificationCountryCode?: string | null | undefined;
+  identificationNumber: string | null;
+  entityTaxId: string | null;
+  entityName: string | null;
+}>;