@edgebound/bigcommerce 0.0.1

package/dist/orders.d.mts

@@ -0,0 +1,416 @@
+import { I as InputValidationError } from './validation.error-CHLpPYC_.mjs';
+import { S as SomeBigCommerceError, B as BigCommerceFetcher } from './bigcommerce.fetcher-D1TyK4y4.mjs';
+import { Effect } from 'effect';
+import * as z from 'zod';
+import 'effect/Cause';
+import 'effect/Types';
+
+declare const FindOrdersCriteriaSchema: z.ZodObject<{
+    customer_id: z.ZodOptional<z.ZodString>;
+    email: z.ZodOptional<z.ZodString>;
+    status_id: z.ZodOptional<z.ZodNumber>;
+    cart_id: z.ZodOptional<z.ZodString>;
+    payment_method: z.ZodOptional<z.ZodString>;
+    min_date_created: z.ZodOptional<z.ZodISODateTime>;
+    max_date_created: z.ZodOptional<z.ZodISODateTime>;
+    min_date_modified: z.ZodOptional<z.ZodISODateTime>;
+    max_date_modified: z.ZodOptional<z.ZodISODateTime>;
+    page: z.ZodOptional<z.ZodNumber>;
+    limit: z.ZodOptional<z.ZodNumber>;
+    sort: z.ZodOptional<z.ZodString>;
+    channel_id: z.ZodOptional<z.ZodInt>;
+}, z.core.$strip>;
+type FindOrdersCriteriaInput = z.input<typeof FindOrdersCriteriaSchema>;
+
+declare const findOrders: (criteria?: FindOrdersCriteriaInput) => Effect.Effect<{
+    id: number;
+    customer_id: number;
+    date_created: string;
+    is_tax_inclusive_pricing: boolean;
+    date_modified: string;
+    date_shipped: string;
+    status_id: number;
+    status: "Incomplete" | "Pending" | "Shipped" | "Partially Shipped" | "Refunded" | "Cancelled" | "Declined" | "Awaiting Payment" | "Awaiting Pickup" | "Awaiting Shipment" | "Completed" | "Awaiting Fulfillment" | "Manual Verification Required" | "Disputed" | "Partially Refunded";
+    subtotal_ex_tax: string;
+    subtotal_inc_tax: string;
+    subtotal_tax: string;
+    base_shipping_cost: string;
+    shipping_cost_ex_tax: string;
+    shipping_cost_inc_tax: string;
+    shipping_cost_tax: string;
+    shipping_cost_tax_class_id: number;
+    base_handling_cost: string;
+    handling_cost_ex_tax: string;
+    handling_cost_inc_tax: string;
+    handling_cost_tax: string;
+    handling_cost_tax_class_id: number;
+    base_wrapping_cost: string;
+    wrapping_cost_ex_tax: string;
+    wrapping_cost_inc_tax: string;
+    wrapping_cost_tax: string;
+    wrapping_cost_tax_class_id: number;
+    total_ex_tax: string;
+    total_inc_tax: string;
+    total_tax: string;
+    items_total: number;
+    items_shipped: number;
+    payment_method: string;
+    payment_provider_id: string;
+    payment_status: string;
+    refunded_amount: string;
+    order_is_digital: boolean;
+    store_credit_amount: string;
+    gift_certificate_amount: string;
+    ip_address: string;
+    ip_address_v6: string;
+    geoip_country: string;
+    geoip_country_iso2: string;
+    currency_id: number;
+    currency_code: string;
+    currency_exchange_rate: string;
+    default_currency_id: number;
+    default_currency_code: string;
+    staff_notes: string;
+    customer_message: string;
+    discount_amount: string;
+    coupon_discount: string;
+    shipping_address_count: number;
+    is_deleted: boolean;
+    ebay_order_id: string;
+    cart_id: string;
+    billing_address: {
+        first_name: string;
+        last_name: string;
+        company: string;
+        street_1: string;
+        street_2: string;
+        city: string;
+        state: string;
+        zip: string;
+        country: string;
+        country_iso2: string;
+        phone: string;
+        email: string;
+        form_fields: {
+            name: string;
+            value: string;
+        }[];
+    };
+    is_email_opt_in: boolean;
+    order_source: string;
+    channel_id: number;
+    external_source: string;
+    external_id: string | null;
+    tax_provider_id: string;
+    customer_locale: string;
+    external_order_id: string | null;
+    store_default_currency_code: string;
+    store_default_to_transactional_exchange_rate: string;
+    custom_status: string;
+}[], SomeBigCommerceError | InputValidationError, BigCommerceFetcher>;
+declare const getAllOrdersBy: (criteria: Omit<FindOrdersCriteriaInput, "page" | "limit">) => Effect.Effect<{
+    id: number;
+    customer_id: number;
+    date_created: string;
+    is_tax_inclusive_pricing: boolean;
+    date_modified: string;
+    date_shipped: string;
+    status_id: number;
+    status: "Incomplete" | "Pending" | "Shipped" | "Partially Shipped" | "Refunded" | "Cancelled" | "Declined" | "Awaiting Payment" | "Awaiting Pickup" | "Awaiting Shipment" | "Completed" | "Awaiting Fulfillment" | "Manual Verification Required" | "Disputed" | "Partially Refunded";
+    subtotal_ex_tax: string;
+    subtotal_inc_tax: string;
+    subtotal_tax: string;
+    base_shipping_cost: string;
+    shipping_cost_ex_tax: string;
+    shipping_cost_inc_tax: string;
+    shipping_cost_tax: string;
+    shipping_cost_tax_class_id: number;
+    base_handling_cost: string;
+    handling_cost_ex_tax: string;
+    handling_cost_inc_tax: string;
+    handling_cost_tax: string;
+    handling_cost_tax_class_id: number;
+    base_wrapping_cost: string;
+    wrapping_cost_ex_tax: string;
+    wrapping_cost_inc_tax: string;
+    wrapping_cost_tax: string;
+    wrapping_cost_tax_class_id: number;
+    total_ex_tax: string;
+    total_inc_tax: string;
+    total_tax: string;
+    items_total: number;
+    items_shipped: number;
+    payment_method: string;
+    payment_provider_id: string;
+    payment_status: string;
+    refunded_amount: string;
+    order_is_digital: boolean;
+    store_credit_amount: string;
+    gift_certificate_amount: string;
+    ip_address: string;
+    ip_address_v6: string;
+    geoip_country: string;
+    geoip_country_iso2: string;
+    currency_id: number;
+    currency_code: string;
+    currency_exchange_rate: string;
+    default_currency_id: number;
+    default_currency_code: string;
+    staff_notes: string;
+    customer_message: string;
+    discount_amount: string;
+    coupon_discount: string;
+    shipping_address_count: number;
+    is_deleted: boolean;
+    ebay_order_id: string;
+    cart_id: string;
+    billing_address: {
+        first_name: string;
+        last_name: string;
+        company: string;
+        street_1: string;
+        street_2: string;
+        city: string;
+        state: string;
+        zip: string;
+        country: string;
+        country_iso2: string;
+        phone: string;
+        email: string;
+        form_fields: {
+            name: string;
+            value: string;
+        }[];
+    };
+    is_email_opt_in: boolean;
+    order_source: string;
+    channel_id: number;
+    external_source: string;
+    external_id: string | null;
+    tax_provider_id: string;
+    customer_locale: string;
+    external_order_id: string | null;
+    store_default_currency_code: string;
+    store_default_to_transactional_exchange_rate: string;
+    custom_status: string;
+}[], SomeBigCommerceError | InputValidationError, BigCommerceFetcher>;
+
+declare const getOrder: (orderId: string) => Effect.Effect<{
+    id: number;
+    customer_id: number;
+    date_created: string;
+    is_tax_inclusive_pricing: boolean;
+    date_modified: string;
+    date_shipped: string;
+    status_id: number;
+    status: "Incomplete" | "Pending" | "Shipped" | "Partially Shipped" | "Refunded" | "Cancelled" | "Declined" | "Awaiting Payment" | "Awaiting Pickup" | "Awaiting Shipment" | "Completed" | "Awaiting Fulfillment" | "Manual Verification Required" | "Disputed" | "Partially Refunded";
+    subtotal_ex_tax: string;
+    subtotal_inc_tax: string;
+    subtotal_tax: string;
+    base_shipping_cost: string;
+    shipping_cost_ex_tax: string;
+    shipping_cost_inc_tax: string;
+    shipping_cost_tax: string;
+    shipping_cost_tax_class_id: number;
+    base_handling_cost: string;
+    handling_cost_ex_tax: string;
+    handling_cost_inc_tax: string;
+    handling_cost_tax: string;
+    handling_cost_tax_class_id: number;
+    base_wrapping_cost: string;
+    wrapping_cost_ex_tax: string;
+    wrapping_cost_inc_tax: string;
+    wrapping_cost_tax: string;
+    wrapping_cost_tax_class_id: number;
+    total_ex_tax: string;
+    total_inc_tax: string;
+    total_tax: string;
+    items_total: number;
+    items_shipped: number;
+    payment_method: string;
+    payment_provider_id: string;
+    payment_status: string;
+    refunded_amount: string;
+    order_is_digital: boolean;
+    store_credit_amount: string;
+    gift_certificate_amount: string;
+    ip_address: string;
+    ip_address_v6: string;
+    geoip_country: string;
+    geoip_country_iso2: string;
+    currency_id: number;
+    currency_code: string;
+    currency_exchange_rate: string;
+    default_currency_id: number;
+    default_currency_code: string;
+    staff_notes: string;
+    customer_message: string;
+    discount_amount: string;
+    coupon_discount: string;
+    shipping_address_count: number;
+    is_deleted: boolean;
+    ebay_order_id: string;
+    cart_id: string;
+    billing_address: {
+        first_name: string;
+        last_name: string;
+        company: string;
+        street_1: string;
+        street_2: string;
+        city: string;
+        state: string;
+        zip: string;
+        country: string;
+        country_iso2: string;
+        phone: string;
+        email: string;
+        form_fields: {
+            name: string;
+            value: string;
+        }[];
+    };
+    is_email_opt_in: boolean;
+    order_source: string;
+    channel_id: number;
+    external_source: string;
+    external_id: string | null;
+    tax_provider_id: string;
+    customer_locale: string;
+    external_order_id: string | null;
+    store_default_currency_code: string;
+    store_default_to_transactional_exchange_rate: string;
+    custom_status: string;
+}, SomeBigCommerceError, BigCommerceFetcher>;
+
+declare const getAllOrderProducts: (orderId: number) => Effect.Effect<{
+    id: number;
+    order_id: number;
+    product_id: number;
+    variant_id: number;
+    order_address_id: number;
+    sku: string;
+    type: "physical" | "digital";
+    base_price: number;
+    price_ex_tax: number;
+    price_inc_tax: number;
+    price_tax: number;
+    base_total: number;
+    total_ex_tax: number;
+    total_inc_tax: number;
+    total_tax: number;
+    weight: number;
+    width: number;
+    height: number;
+    depth: number;
+    quantity: number;
+    base_cost_price: number;
+    cost_price_inc_tax: number;
+    cost_price_ex_tax: number;
+    cost_price_tax: number;
+}[], SomeBigCommerceError, BigCommerceFetcher>;
+
+declare const OrderSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    customer_id: z.ZodNumber;
+    date_created: z.ZodString;
+    is_tax_inclusive_pricing: z.ZodBoolean;
+    date_modified: z.ZodString;
+    date_shipped: z.ZodString;
+    status_id: z.ZodNumber;
+    status: z.ZodEnum<{
+        Incomplete: "Incomplete";
+        Pending: "Pending";
+        Shipped: "Shipped";
+        "Partially Shipped": "Partially Shipped";
+        Refunded: "Refunded";
+        Cancelled: "Cancelled";
+        Declined: "Declined";
+        "Awaiting Payment": "Awaiting Payment";
+        "Awaiting Pickup": "Awaiting Pickup";
+        "Awaiting Shipment": "Awaiting Shipment";
+        Completed: "Completed";
+        "Awaiting Fulfillment": "Awaiting Fulfillment";
+        "Manual Verification Required": "Manual Verification Required";
+        Disputed: "Disputed";
+        "Partially Refunded": "Partially Refunded";
+    }>;
+    subtotal_ex_tax: z.ZodString;
+    subtotal_inc_tax: z.ZodString;
+    subtotal_tax: z.ZodString;
+    base_shipping_cost: z.ZodString;
+    shipping_cost_ex_tax: z.ZodString;
+    shipping_cost_inc_tax: z.ZodString;
+    shipping_cost_tax: z.ZodString;
+    shipping_cost_tax_class_id: z.ZodNumber;
+    base_handling_cost: z.ZodString;
+    handling_cost_ex_tax: z.ZodString;
+    handling_cost_inc_tax: z.ZodString;
+    handling_cost_tax: z.ZodString;
+    handling_cost_tax_class_id: z.ZodNumber;
+    base_wrapping_cost: z.ZodString;
+    wrapping_cost_ex_tax: z.ZodString;
+    wrapping_cost_inc_tax: z.ZodString;
+    wrapping_cost_tax: z.ZodString;
+    wrapping_cost_tax_class_id: z.ZodNumber;
+    total_ex_tax: z.ZodString;
+    total_inc_tax: z.ZodString;
+    total_tax: z.ZodString;
+    items_total: z.ZodNumber;
+    items_shipped: z.ZodNumber;
+    payment_method: z.ZodString;
+    payment_provider_id: z.ZodString;
+    payment_status: z.ZodString;
+    refunded_amount: z.ZodString;
+    order_is_digital: z.ZodBoolean;
+    store_credit_amount: z.ZodString;
+    gift_certificate_amount: z.ZodString;
+    ip_address: z.ZodString;
+    ip_address_v6: z.ZodString;
+    geoip_country: z.ZodString;
+    geoip_country_iso2: z.ZodString;
+    currency_id: z.ZodNumber;
+    currency_code: z.ZodString;
+    currency_exchange_rate: z.ZodString;
+    default_currency_id: z.ZodNumber;
+    default_currency_code: z.ZodString;
+    staff_notes: z.ZodString;
+    customer_message: z.ZodString;
+    discount_amount: z.ZodString;
+    coupon_discount: z.ZodString;
+    shipping_address_count: z.ZodNumber;
+    is_deleted: z.ZodBoolean;
+    ebay_order_id: z.ZodString;
+    cart_id: z.ZodString;
+    billing_address: z.ZodObject<{
+        first_name: z.ZodString;
+        last_name: z.ZodString;
+        company: z.ZodString;
+        street_1: z.ZodString;
+        street_2: z.ZodString;
+        city: z.ZodString;
+        state: z.ZodString;
+        zip: z.ZodString;
+        country: z.ZodString;
+        country_iso2: z.ZodString;
+        phone: z.ZodString;
+        email: z.ZodString;
+        form_fields: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            value: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    is_email_opt_in: z.ZodBoolean;
+    order_source: z.ZodString;
+    channel_id: z.ZodNumber;
+    external_source: z.ZodString;
+    external_id: z.ZodNullable<z.ZodString>;
+    tax_provider_id: z.ZodString;
+    customer_locale: z.ZodString;
+    external_order_id: z.ZodNullable<z.ZodString>;
+    store_default_currency_code: z.ZodString;
+    store_default_to_transactional_exchange_rate: z.ZodString;
+    custom_status: z.ZodString;
+}, z.core.$strip>;
+type Order = z.output<typeof OrderSchema>;
+
+export { type Order, OrderSchema, findOrders, getAllOrderProducts, getAllOrdersBy, getOrder };