@betterstore/sdk 0.5.24 → 0.6.0

package/dist/index.d.mts

@@ -1,455 +1,8 @@
+import { OTPSignupParams, OTPSignupResponse, OTPLoginParams, OTPLoginResponse, OTPVerifyParams, OTPVerifyResponse, CustomerSession, CheckoutCreateParams, CheckoutSession, CheckoutUpdateParams, GetShippingRatesResponse, CustomerCreateParams, CustomerResponse, CustomerUpdateParams, AutosuggestAddressResult, LookupAddressResult, ListCollectionsParams, ListCollectionsResponse, RetrieveCollectionParams, RetrieveCollectionResponse, CustomerSubscriptionUpdateParams, CustomerSubscription, ListDiscountsParams, ListDiscountsResponse, RetrieveDiscountParams, RetrieveDiscountResponse, ListProductsParams, ListProductsResponse, RetrieveProductParams, RetrieveProductResponse } from '@betterstore/bridge';
 import axios from 'axios';
 
 declare const createApiClient: (apiKey: string, proxy?: string) => axios.AxiosInstance;
 
-interface GetShippingRatesResponse {
-    [shipmentId: string]: ShippingRate[];
-}
-type ShippingVendorCarrierType = "zasilkovna";
-type ProviderId = "zasilkovna";
-type ShippingRate = FixedRate | PlatformCarrierRate | CustomShippingVendorRate | PrebuiltRate;
-interface FixedRate {
-    id: string;
-    type: "FIXED";
-    name: string;
-    description?: string;
-    priceInCents: number;
-}
-interface BasePlatformCarrierRate {
-    id: string;
-    providerId: ProviderId;
-    type: "PLATFORM_CARRIER";
-    platformCarrierSlug: string;
-    priceInCents: number;
-}
-interface ZasilkovnaPlatformCarrierRate extends BasePlatformCarrierRate {
-    providerId: "zasilkovna";
-    platformCarrierSlug: "bs_platform_zasilkovna";
-    service: "z_box";
-    clientSecret: string;
-}
-type PlatformCarrierRate = ZasilkovnaPlatformCarrierRate;
-interface BaseCustomShippingVendorRate {
-    id: string;
-    providerId: ProviderId;
-    type: "CUSTOM_SHIPPING_VENDOR";
-    shippingVendorCarrierType: ShippingVendorCarrierType;
-    priceInCents: number;
-}
-interface ZasilkovnaCustomShippingVendorRate extends BaseCustomShippingVendorRate {
-    providerId: "zasilkovna";
-    shippingVendorCarrierType: Extract<ShippingVendorCarrierType, "zasilkovna">;
-    service: "z_box";
-    clientSecret: string;
-}
-type CustomShippingVendorRate = ZasilkovnaCustomShippingVendorRate;
-type PrebuiltRateType = "PICKUP_IN_STORE" | "LOCAL_DELIVERY";
-interface BasePrebuiltRate {
-    id: string;
-    type: "PREBUILT";
-    prebuiltRateType: PrebuiltRateType;
-    priceInCents: number;
-}
-interface PrebuildPickupInStoreRate extends BasePrebuiltRate {
-    prebuiltRateType: Extract<PrebuiltRateType, "PICKUP_IN_STORE">;
-    expectedPickupDateInHours: number;
-}
-interface PrebuiltLocalDeliveryRate extends BasePrebuiltRate {
-    prebuiltRateType: Extract<PrebuiltRateType, "LOCAL_DELIVERY">;
-}
-type PrebuiltRate = PrebuildPickupInStoreRate | PrebuiltLocalDeliveryRate;
-
-type ProductData = Pick<Product, "title" | "description" | "images" | "category" | "tags" | "sku" | "barcode" | "vendor" | "isPhysical" | "weightInGrams" | "heightInCm" | "widthInCm" | "lengthInCm" | "priceInCents" | "billingType" | "billingInterval" | "billingIntervalCount"> & {
-    productId: string;
-    selectedVariant: Pick<ProductVariant, "title" | "description" | "sku" | "barcode" | "images" | "isPhysical" | "weightInGrams" | "heightInCm" | "widthInCm" | "lengthInCm" | "priceInCents" | "billingType" | "billingInterval" | "billingIntervalCount" | "variantOptions" | "metadata">;
-};
-interface LineItem {
-    quantity: number;
-    variantOptions: {
-        name: string;
-        value: string;
-    }[];
-    productData: ProductData;
-    metadata?: string;
-}
-interface LineItemCreate extends Omit<LineItem, "productData" | "product" | "metadata" | "variantOptions"> {
-    variantOptions?: {
-        name: string;
-        value: string;
-    }[];
-    productId: string;
-    product?: ProductWithoutVariants;
-    metadata?: Record<string, any>;
-}
-type Currency = string;
-interface CheckoutCreateParams {
-    type: "hosted" | "embed";
-    customerId?: string;
-    lineItems: LineItemCreate[];
-    currency?: Currency;
-    discountCodes?: string[];
-}
-interface CheckoutUpdateParams {
-    customerId?: string;
-    shipments?: CheckoutShipment[];
-}
-
-type ShipmentData = {
-    rateId: string;
-    providerId?: string;
-    priceInCents: number;
-    pickupPointId?: string;
-    trackingId?: string;
-    trackingUrl?: string;
-};
-type CheckoutShipment = {
-    id: string;
-    shipmentData?: ShipmentData | null;
-};
-interface CheckoutSession {
-    id: string;
-    testmode: boolean;
-    clientSecret: string;
-    customer?: {
-        id: string;
-        address?: Address;
-        email?: string;
-    };
-    lineItems: LineItem[];
-    tax: number | null;
-    discountAmount: number | null;
-    appliedDiscounts: {
-        id: string;
-        amount: number;
-        allowedLineItems: {
-            productId: string;
-            quantity: number;
-        }[];
-        discount: Discount;
-    }[];
-    currency: string;
-    exchangeRate: number | null;
-    shipments: CheckoutShipment[];
-    status: "IN_PROGRESS" | "PAYMENT_PENDING" | "ABANDONED" | "CANCELED" | "FAILED";
-}
-
-type AutosuggestAddressResult = {
-    id: string;
-    title: string;
-    address: {
-        label: string;
-    };
-    position: {
-        lat: number;
-        lng: number;
-    };
-};
-type LookupAddressResult = {
-    id: string;
-    title: string;
-    address: Pick<Address, "line1" | "city" | "province" | "provinceCode" | "country" | "countryCode" | "zipCode">;
-};
-
-type SortOrder = "asc" | "desc";
-type GetListParams<A, B> = {
-    sortBy?: A;
-    sortOrder?: SortOrder;
-    query?: B & {
-        NOT?: B | B[];
-        OR?: B[];
-    };
-};
-type EnumQueryType<T> = {
-    equals?: T;
-    in?: T[];
-    not?: T;
-    notIn?: T[];
-};
-type StringArrayQueryType<T = string> = {
-    equals?: T[];
-    has?: T;
-    hasEvery?: T[];
-    hasSome?: T[];
-    isEmpty?: boolean;
-};
-type DateQueryType = {
-    equals?: Date;
-    in?: Date[];
-    not?: Date;
-    notIn?: Date[];
-    gt?: Date;
-    gte?: Date;
-    lt?: Date;
-    lte?: Date;
-};
-type OptionalDateQueryType = DateQueryType & {
-    isSet: boolean;
-};
-type ArrayModelQueryType<T> = {
-    some?: T;
-    every?: T;
-    none?: T;
-};
-
-interface VariantOption {
-    name: string;
-    value: string;
-}
-interface ProductVariant {
-    title: string;
-    description?: string;
-    images: string[];
-    sku?: string;
-    barcode?: string;
-    inventoryItem: {
-        stockPolicy: "CONTINUE" | "DENY";
-        trackInventory: boolean;
-    };
-    isPhysical: boolean;
-    weightInGrams?: number;
-    heightInCm?: number;
-    widthInCm?: number;
-    lengthInCm?: number;
-    priceInCents: number;
-    billingType: ProductBillingType;
-    billingInterval: ProductBillingInterval;
-    billingIntervalCount: number;
-    metadata?: Record<string, any>;
-    variantOptions: VariantOption[];
-}
-interface ProductOption {
-    name: string;
-    values: string[];
-}
-type ProductStatus = "DRAFT" | "ACTIVE" | "ARCHIVED";
-type ProductBillingInterval = "DAY" | "WEEK" | "MONTH" | "YEAR";
-type ProductBillingType = "ONE_TIME" | "SUBSCRIPTION";
-interface Product {
-    id: string;
-    createdAt: Date;
-    updatedAt: Date;
-    title: string;
-    description?: string;
-    images: string[];
-    category: string;
-    tags: string[];
-    isPhysical: boolean;
-    weightInGrams?: number;
-    heightInCm?: number;
-    widthInCm?: number;
-    lengthInCm?: number;
-    priceInCents: number;
-    billingType: ProductBillingType;
-    billingInterval: ProductBillingInterval;
-    billingIntervalCount: number;
-    sku?: string;
-    barcode?: string;
-    inventoryItem: {
-        stockPolicy: "CONTINUE" | "DENY";
-        trackInventory: boolean;
-    };
-    seoPageTitle?: string;
-    seoDescription?: string;
-    seoHandle?: string;
-    vendor?: string;
-    metadata?: Record<string, any>;
-    status: ProductStatus;
-    options: ProductOption[];
-    productVariants: ProductVariant[];
-}
-interface ProductWithoutVariants extends Omit<Product, "productVariants"> {
-}
-type ListProductsQuery = {
-    collectionIDs?: StringArrayQueryType;
-    collections?: ArrayModelQueryType<{
-        seoHandle?: StringArrayQueryType;
-    }>;
-    tags?: StringArrayQueryType;
-    createdAt?: DateQueryType;
-    updatedAt?: DateQueryType;
-};
-type ListProductsSortBy = "createdAt" | "updatedAt" | "title" | "priceInCents";
-type ListProductsParams = GetListParams<ListProductsSortBy, ListProductsQuery>;
-type RetrieveProductParams = {
-    seoHandle: string;
-} | {
-    id: string;
-};
-
-interface Collection {
-    id: string;
-    title: string;
-    description?: string;
-    images: string[];
-    tags: string[];
-    seoPageTitle?: string;
-    seoDescription?: string;
-    seoHandle?: string;
-}
-interface CollectionWithProducts extends Collection {
-    products: ProductWithoutVariants[];
-}
-type ListCollectionsQuery = undefined;
-type ListCollectionsSortBy = "createdAt" | "updatedAt" | "title";
-type ListCollectionsParams = GetListParams<ListCollectionsSortBy, ListCollectionsQuery>;
-type RetrieveCollectionParams = {
-    seoHandle: string;
-} | {
-    id: string;
-};
-
-type Address = {
-    name: string;
-    phone: string;
-    line1: string;
-    line2?: string;
-    city: string;
-    province?: string;
-    provinceCode?: string;
-    country: string;
-    countryCode: string;
-    zipCode: string;
-};
-interface CustomerCreateParams {
-    firstName?: string;
-    lastName?: string;
-    email: string;
-    phone?: string;
-    address?: Address;
-    image?: string;
-    password?: string;
-    metadata?: Record<string, any>;
-    tags?: string[];
-    notes?: string;
-    isSubscribedEmail?: boolean;
-    isSubscribedSMS?: boolean;
-}
-interface CustomerUpdateParams extends Omit<CustomerCreateParams, "email"> {
-    email?: string;
-}
-interface Customer$1 extends CustomerCreateParams {
-    id: string;
-    createdAt: string;
-    updatedAt: string;
-}
-interface CustomerSubscription {
-    cancelAtPeriodEnd: boolean;
-}
-type CustomerSubscriptionUpdateParams = Partial<Pick<CustomerSubscription, "cancelAtPeriodEnd">>;
-
-interface Discount {
-    id: string;
-    createdAt: Date;
-    updatedAt: Date;
-    type: "AMOUNT_OFF_PRODUCTS" | "BUY_X_GET_Y" | "AMOUNT_OFF_ORDER" | "FREE_SHIPPING";
-    method: "CODE" | "AUTOMATIC";
-    code?: string | null;
-    title?: string | null;
-    value: number;
-    valueType: "PERCENTAGE" | "FIXED_AMOUNT" | "FREE";
-    discountScope: "PRODUCTS" | "COLLECTIONS";
-    allowedProductIDs: string[];
-    allowedCollectionIDs: string[];
-    allowedCombinations: ("ORDER" | "PRODUCT" | "SHIPPING")[];
-    minimumRequirementsType: "NONE" | "MINIMUM_ORDER_AMOUNT" | "MINIMUM_PRODUCT_QUANTITY";
-    minimumRequirementsValue?: number | null;
-    requiredProductIDs: string[];
-    requiredCollectionIDs: string[];
-    minimumRequirementsScope: "PRODUCTS" | "COLLECTIONS";
-    maxUses?: number | null;
-    maxUsesPerCustomer?: number | null;
-    maxAllowedProductQuantity?: number | null;
-    uses: number;
-    subscriptionDiscountDurationType: "ONE_TIME" | "RECURRING" | "FOREVER";
-    subscriptionDiscountDurationValue: number;
-    stripeDiscountId?: string | null;
-    startsAt: Date;
-    expiresAt?: Date | null;
-    status: "ACTIVE" | "EXPIRED" | "SCHEDULED";
-    organizationId: string;
-}
-type ListDiscountsQuery = {
-    type?: EnumQueryType<Discount["type"]>;
-    valueType?: EnumQueryType<Discount["valueType"]>;
-    method?: EnumQueryType<Discount["method"]>;
-    status?: EnumQueryType<Discount["status"]>;
-    minimumRequirementsType?: EnumQueryType<Discount["minimumRequirementsType"]>;
-    minimumRequirementsScope?: EnumQueryType<Discount["minimumRequirementsScope"]>;
-    discountScope?: EnumQueryType<Discount["discountScope"]>;
-    subscriptionDiscountDurationType?: EnumQueryType<Discount["subscriptionDiscountDurationType"]>;
-    allowedCombinations?: StringArrayQueryType<Discount["allowedCombinations"]>;
-    allowedProductIDs?: StringArrayQueryType<Discount["allowedProductIDs"]>;
-    allowedCollectionIDs?: StringArrayQueryType<Discount["allowedCollectionIDs"]>;
-    requiredProductIDs?: StringArrayQueryType<Discount["requiredProductIDs"]>;
-    requiredCollectionIDs?: StringArrayQueryType<Discount["requiredCollectionIDs"]>;
-    startsAt?: DateQueryType;
-    expiresAt?: OptionalDateQueryType;
-    createdAt?: DateQueryType;
-    updatedAt?: DateQueryType;
-};
-type ListDiscountsSortBy = "createdAt" | "updatedAt" | "expiresAt" | "startsAt";
-type ListDiscountsParams = GetListParams<ListDiscountsSortBy, ListDiscountsQuery>;
-type RetrieveDiscountParams = {
-    id: string;
-} | {
-    code: string;
-};
-
-interface CustomerSession {
-    customerId: string;
-    expiresAt: Date;
-    testmode: boolean;
-    token: string;
-    customer: {
-        createdAt: Date;
-        updatedAt: Date;
-        firstName: string;
-        lastName: string;
-        email: string;
-        phone?: string;
-        password?: string;
-        image?: string;
-        metadata?: string;
-        stripeCustomerId: string;
-        isSubscribedEmail: boolean;
-        isSubscribedSMS: boolean;
-        address: Address;
-    };
-}
-interface OTPLoginParams {
-    email: string;
-}
-interface OTPSignupParams extends CustomerCreateParams {
-}
-interface OTPVerifyParams {
-    email: string;
-    otp: string;
-}
-type OTPLoginResponse = {
-    success: true;
-    token: string;
-} | {
-    success: false;
-    code: "BAD_REQUEST" | "CUSTOMER_NOT_FOUND";
-    error: string;
-};
-type OTPSignupResponse = {
-    success: true;
-    token: string;
-} | {
-    success: false;
-    code: "BAD_REQUEST" | "CUSTOMER_ALREADY_EXISTS";
-    error: string;
-};
-type OTPVerifyResponse = {
-    success: true;
-    customerSession: CustomerSession;
-} | {
-    success: false;
-    code: "BAD_REQUEST";
-    error: string;
-};
-
 declare class OTP {
     private apiClient;
     constructor(apiClient: ReturnType<typeof createApiClient>);
@@ -532,7 +85,7 @@ declare class Client {
     /**
      * Get shipping rates for a checkout session
      */
-    getCheckoutShippingRates(clientSecret: string, checkoutId: string): Promise<ShippingRate[]>;
+    getCheckoutShippingRates(clientSecret: string, checkoutId: string): Promise<GetShippingRatesResponse>;
     /**
      * Generate payment secret for a checkout session
      */
@@ -544,15 +97,15 @@ declare class Client {
     /**
      * Create a new customer
      */
-    createCustomer(clientSecret: string, params: CustomerCreateParams): Promise<Customer$1>;
+    createCustomer(clientSecret: string, params: CustomerCreateParams): Promise<CustomerResponse>;
     /**
      * Retrieve a customer by ID or email
      */
-    retrieveCustomer(clientSecret: string, idOrEmail: string): Promise<Customer$1 | null>;
+    retrieveCustomer(clientSecret: string, idOrEmail: string): Promise<CustomerResponse | null>;
     /**
      * Update a customer
      */
-    updateCustomer(clientSecret: string, customerId: string, params: CustomerUpdateParams): Promise<Customer$1 | null>;
+    updateCustomer(clientSecret: string, customerId: string, params: CustomerUpdateParams): Promise<CustomerResponse | null>;
     /**
      * Get exchange rate for a currency
      */
@@ -576,8 +129,8 @@ declare class Client {
 declare class Collections {
     private apiClient;
     constructor(apiKey: string, proxy?: string);
-    list(params?: ListCollectionsParams): Promise<Collection[]>;
-    retrieve(params: RetrieveCollectionParams): Promise<CollectionWithProducts | null>;
+    list<T extends ListCollectionsParams>(params?: T): Promise<ListCollectionsResponse<T>>;
+    retrieve<T extends RetrieveCollectionParams>(params: T): Promise<RetrieveCollectionResponse<T> | null>;
 }
 
 declare class Customer {
@@ -586,15 +139,15 @@ declare class Customer {
     /**
      * Create a new customer
      */
-    create(params: CustomerCreateParams): Promise<Customer$1>;
+    create(params: CustomerCreateParams): Promise<CustomerResponse>;
     /**
      * Retrieve a customer by ID or email
      */
-    retrieve(idOrEmail: string): Promise<Customer$1 | null>;
+    retrieve(idOrEmail: string): Promise<CustomerResponse | null>;
     /**
      * Update a customer
      */
-    update(customerId: string, params: CustomerUpdateParams): Promise<Customer$1 | null>;
+    update(customerId: string, params: CustomerUpdateParams): Promise<CustomerResponse | null>;
     /**
      * Delete a customer
      */
@@ -608,22 +161,15 @@ declare class Customer {
 declare class Discounts {
     private apiClient;
     constructor(apiKey: string, proxy?: string);
-    list(params?: ListDiscountsParams): Promise<Discount[]>;
-    retrieve(params: RetrieveDiscountParams): Promise<Discount | null>;
-}
-
-declare class Helpers {
-    proxy?: string;
-    constructor(proxy?: string);
-    formatCurrency(currency: string): string;
-    formatPrice(priceInCents: number, currency: string, exchangeRate?: number | null): string;
+    list<T extends ListDiscountsParams>(params?: T): Promise<ListDiscountsResponse>;
+    retrieve<T extends RetrieveDiscountParams>(params: T): Promise<RetrieveDiscountResponse | null>;
 }
 
 declare class Products {
     private apiClient;
     constructor(apiKey: string, proxy?: string);
-    list(params?: ListProductsParams): Promise<ProductWithoutVariants[]>;
-    retrieve(params: RetrieveProductParams): Promise<Product | null>;
+    list<T extends ListProductsParams>(params?: T): Promise<ListProductsResponse<T>>;
+    retrieve<T extends RetrieveProductParams>(params: T): Promise<RetrieveProductResponse<T> | null>;
 }
 
 declare function createBetterStore(config: {
@@ -640,8 +186,5 @@ declare function createBetterStore(config: {
 declare function createStoreClient(config?: {
     proxy?: string;
 }): Client;
-declare function createStoreHelpers(config?: {
-    proxy?: string;
-}): Helpers;
 
-export { type Address, type AutosuggestAddressResult, type CheckoutCreateParams, type CheckoutSession, type CheckoutUpdateParams, type Collection, type CollectionWithProducts, type Currency, type Customer$1 as Customer, type CustomerCreateParams, type CustomerSession, type CustomerSubscription, type CustomerSubscriptionUpdateParams, type CustomerUpdateParams, type Discount, type GetShippingRatesResponse, type LineItem, type LineItemCreate, type ListCollectionsParams, type ListCollectionsQuery, type ListCollectionsSortBy, type ListDiscountsParams, type ListDiscountsQuery, type ListDiscountsSortBy, type ListProductsParams, type ListProductsQuery, type ListProductsSortBy, type LookupAddressResult, type OTPLoginParams, type OTPLoginResponse, type OTPSignupParams, type OTPSignupResponse, type OTPVerifyParams, type OTPVerifyResponse, type Product, type ProductBillingInterval, type ProductBillingType, type ProductOption, type ProductStatus, type ProductVariant, type ProductWithoutVariants, type RetrieveCollectionParams, type RetrieveDiscountParams, type RetrieveProductParams, type ShippingRate, type VariantOption, createStoreClient, createStoreHelpers, createBetterStore as default };
+export { createStoreClient, createBetterStore as default };