@betterstore/sdk 0.3.48 → 0.3.50

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @betterstore/sdk
 
+## 0.3.50
+
+### Patch Changes
+
+- discounts handeling finished
+
+## 0.3.49
+
+### Patch Changes
+
+- collection utility functions
+
 ## 0.3.48
 
 ### Patch Changes

package/dist/index.d.mts

@@ -102,6 +102,9 @@ interface Collection {
     seoDescription?: string;
     seoHandle?: string;
 }
+interface CollectionWithProducts extends Collection {
+    products: ProductWithoutVariants[];
+}
 
 type ShippingRate = ZasilkovnaRate;
 interface BaseRate {
@@ -138,6 +141,7 @@ interface CheckoutCreateParams {
     customerId?: string;
     lineItems: LineItemCreate[];
     currency?: Currency;
+    discountCode?: string;
 }
 interface CheckoutUpdateParams {
     customerId?: string;
@@ -150,24 +154,61 @@ interface CheckoutUpdateParams {
     };
 }
 
-interface CheckoutSession {
+type ShipmentData = {
+    provider: string;
+    name?: string;
+    service?: string;
+    pickupPointId?: string;
+    trackingId?: string;
+    trackingUrl?: string;
+};
+type Discount = {
     id: string;
     createdAt: Date;
     updatedAt: Date;
-    clientSecret: string;
-    lineItems: LineItem[];
-    total?: number;
-    subtotal?: number;
-    tax?: number;
-    shipping?: number;
-    currency: string;
-    exchangeRate: number;
-    status: "IN_PROGRESS" | "PAYMENT_PENDING" | "ABANDONED" | "CANCELED" | "FAILED";
+    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;
+    startsAt: Date;
+    expiresAt?: Date | null;
+    status: "ACTIVE" | "EXPIRED" | "SCHEDULED";
+    organizationId: string;
+};
+interface CheckoutSession {
+    id: string;
+    testmode: boolean;
     customer?: {
         id: string;
         address?: Address;
         email?: string;
     };
+    lineItems: LineItem[];
+    tax: number | null;
+    shipping: number | null;
+    discountAmount: number | null;
+    appliedDiscounts: {
+        discount: Discount;
+    }[];
+    currency: string;
+    exchangeRate: number | null;
+    shipmentData: ShipmentData | null;
+    status: "IN_PROGRESS" | "PAYMENT_PENDING" | "ABANDONED" | "CANCELED" | "FAILED";
 }
 type RecursiveRecord = {
     [key: string]: any;
@@ -188,6 +229,14 @@ declare class Checkout {
      * Update a checkout session
      */
     update(checkoutId: string, params: CheckoutUpdateParams): Promise<CheckoutSession>;
+    /**
+     * Update a checkout session
+     */
+    applyDiscountCode(checkoutId: string, discountCode: string): Promise<CheckoutSession>;
+    /**
+     * Update a checkout session
+     */
+    revalidateDiscounts(checkoutId: string): Promise<CheckoutSession>;
     /**
      * Get shipping rates for a checkout session
      */
@@ -212,6 +261,14 @@ declare class Client {
      * Update a checkout session
      */
     updateCheckout(clientSecret: string, checkoutId: string, params: CheckoutUpdateParams): Promise<CheckoutSession>;
+    /**
+     * Update a checkout session
+     */
+    applyDiscountCode(clientSecret: string, checkoutId: string, discountCode: string): Promise<CheckoutSession>;
+    /**
+     * Update a checkout session
+     */
+    revalidateDiscounts(clientSecret: string, checkoutId: string): Promise<CheckoutSession>;
     /**
      * Get shipping rates for a checkout session
      */
@@ -272,6 +329,8 @@ declare class Products {
     list(): Promise<ProductWithoutVariants[]>;
     retrieve(productId: string): Promise<Product | null>;
     listCollections(): Promise<Collection[]>;
+    retrieveCollectionBySeoHandle(collectionSeoHandle: string): Promise<CollectionWithProducts>;
+    retrieveCollectionById(collectionId: string): Promise<CollectionWithProducts>;
 }
 
 declare function createBetterStore(config: {
@@ -289,4 +348,4 @@ declare function createStoreHelpers(config?: {
     proxy?: string;
 }): Helpers;
 
-export { type Address, type CheckoutCreateParams, type CheckoutSession, type CheckoutUpdateParams, type Collection, type Currency, type Customer$1 as Customer, type CustomerCreateParams, type CustomerUpdateParams, type LineItem, type LineItemCreate, type Product, type ProductOption, ProductStatus, type ProductVariant, type ProductWithoutVariants, type ShippingRate, type VariantOption, createStoreClient, createStoreHelpers, createBetterStore as default };
+export { type Address, type CheckoutCreateParams, type CheckoutSession, type CheckoutUpdateParams, type Collection, type CollectionWithProducts, type Currency, type Customer$1 as Customer, type CustomerCreateParams, type CustomerUpdateParams, type LineItem, type LineItemCreate, type Product, type ProductOption, ProductStatus, type ProductVariant, type ProductWithoutVariants, type ShippingRate, type VariantOption, createStoreClient, createStoreHelpers, createBetterStore as default };

package/dist/index.d.ts

@@ -102,6 +102,9 @@ interface Collection {
     seoDescription?: string;
     seoHandle?: string;
 }
+interface CollectionWithProducts extends Collection {
+    products: ProductWithoutVariants[];
+}
 
 type ShippingRate = ZasilkovnaRate;
 interface BaseRate {
@@ -138,6 +141,7 @@ interface CheckoutCreateParams {
     customerId?: string;
     lineItems: LineItemCreate[];
     currency?: Currency;
+    discountCode?: string;
 }
 interface CheckoutUpdateParams {
     customerId?: string;
@@ -150,24 +154,61 @@ interface CheckoutUpdateParams {
     };
 }
 
-interface CheckoutSession {
+type ShipmentData = {
+    provider: string;
+    name?: string;
+    service?: string;
+    pickupPointId?: string;
+    trackingId?: string;
+    trackingUrl?: string;
+};
+type Discount = {
     id: string;
     createdAt: Date;
     updatedAt: Date;
-    clientSecret: string;
-    lineItems: LineItem[];
-    total?: number;
-    subtotal?: number;
-    tax?: number;
-    shipping?: number;
-    currency: string;
-    exchangeRate: number;
-    status: "IN_PROGRESS" | "PAYMENT_PENDING" | "ABANDONED" | "CANCELED" | "FAILED";
+    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;
+    startsAt: Date;
+    expiresAt?: Date | null;
+    status: "ACTIVE" | "EXPIRED" | "SCHEDULED";
+    organizationId: string;
+};
+interface CheckoutSession {
+    id: string;
+    testmode: boolean;
     customer?: {
         id: string;
         address?: Address;
         email?: string;
     };
+    lineItems: LineItem[];
+    tax: number | null;
+    shipping: number | null;
+    discountAmount: number | null;
+    appliedDiscounts: {
+        discount: Discount;
+    }[];
+    currency: string;
+    exchangeRate: number | null;
+    shipmentData: ShipmentData | null;
+    status: "IN_PROGRESS" | "PAYMENT_PENDING" | "ABANDONED" | "CANCELED" | "FAILED";
 }
 type RecursiveRecord = {
     [key: string]: any;
@@ -188,6 +229,14 @@ declare class Checkout {
      * Update a checkout session
      */
     update(checkoutId: string, params: CheckoutUpdateParams): Promise<CheckoutSession>;
+    /**
+     * Update a checkout session
+     */
+    applyDiscountCode(checkoutId: string, discountCode: string): Promise<CheckoutSession>;
+    /**
+     * Update a checkout session
+     */
+    revalidateDiscounts(checkoutId: string): Promise<CheckoutSession>;
     /**
      * Get shipping rates for a checkout session
      */
@@ -212,6 +261,14 @@ declare class Client {
      * Update a checkout session
      */
     updateCheckout(clientSecret: string, checkoutId: string, params: CheckoutUpdateParams): Promise<CheckoutSession>;
+    /**
+     * Update a checkout session
+     */
+    applyDiscountCode(clientSecret: string, checkoutId: string, discountCode: string): Promise<CheckoutSession>;
+    /**
+     * Update a checkout session
+     */
+    revalidateDiscounts(clientSecret: string, checkoutId: string): Promise<CheckoutSession>;
     /**
      * Get shipping rates for a checkout session
      */
@@ -272,6 +329,8 @@ declare class Products {
     list(): Promise<ProductWithoutVariants[]>;
     retrieve(productId: string): Promise<Product | null>;
     listCollections(): Promise<Collection[]>;
+    retrieveCollectionBySeoHandle(collectionSeoHandle: string): Promise<CollectionWithProducts>;
+    retrieveCollectionById(collectionId: string): Promise<CollectionWithProducts>;
 }
 
 declare function createBetterStore(config: {
@@ -289,4 +348,4 @@ declare function createStoreHelpers(config?: {
     proxy?: string;
 }): Helpers;
 
-export { type Address, type CheckoutCreateParams, type CheckoutSession, type CheckoutUpdateParams, type Collection, type Currency, type Customer$1 as Customer, type CustomerCreateParams, type CustomerUpdateParams, type LineItem, type LineItemCreate, type Product, type ProductOption, ProductStatus, type ProductVariant, type ProductWithoutVariants, type ShippingRate, type VariantOption, createStoreClient, createStoreHelpers, createBetterStore as default };
+export { type Address, type CheckoutCreateParams, type CheckoutSession, type CheckoutUpdateParams, type Collection, type CollectionWithProducts, type Currency, type Customer$1 as Customer, type CustomerCreateParams, type CustomerUpdateParams, type LineItem, type LineItemCreate, type Product, type ProductOption, ProductStatus, type ProductVariant, type ProductWithoutVariants, type ShippingRate, type VariantOption, createStoreClient, createStoreHelpers, createBetterStore as default };

package/dist/index.js

@@ -163,6 +163,29 @@ var Checkout = class {
       return data;
     });
   }
+  /**
+   * Update a checkout session
+   */
+  applyDiscountCode(checkoutId, discountCode) {
+    return __async(this, null, function* () {
+      const data = yield this.apiClient.post(
+        `/checkout/${checkoutId}/discount`,
+        { code: discountCode }
+      );
+      return data;
+    });
+  }
+  /**
+   * Update a checkout session
+   */
+  revalidateDiscounts(checkoutId) {
+    return __async(this, null, function* () {
+      const data = yield this.apiClient.get(
+        `/checkout/${checkoutId}/revalidate-discounts`
+      );
+      return data;
+    });
+  }
   /**
    * Get shipping rates for a checkout session
    */
@@ -220,6 +243,31 @@ var Client = class {
       return data;
     });
   }
+  /**
+   * Update a checkout session
+   */
+  applyDiscountCode(clientSecret, checkoutId, discountCode) {
+    return __async(this, null, function* () {
+      const apiClient = createApiClient(clientSecret, this.proxy);
+      const data = yield apiClient.post(
+        `/checkout/${checkoutId}/discount`,
+        { code: discountCode }
+      );
+      return data;
+    });
+  }
+  /**
+   * Update a checkout session
+   */
+  revalidateDiscounts(clientSecret, checkoutId) {
+    return __async(this, null, function* () {
+      const apiClient = createApiClient(clientSecret, this.proxy);
+      const data = yield apiClient.get(
+        `/checkout/${checkoutId}/revalidate-discounts`
+      );
+      return data;
+    });
+  }
   /**
    * Get shipping rates for a checkout session
    */
@@ -469,6 +517,22 @@ var Products = class {
       return data;
     });
   }
+  retrieveCollectionBySeoHandle(collectionSeoHandle) {
+    return __async(this, null, function* () {
+      const data = yield this.apiClient.get(
+        `/collections/${collectionSeoHandle}`
+      );
+      return data;
+    });
+  }
+  retrieveCollectionById(collectionId) {
+    return __async(this, null, function* () {
+      const data = yield this.apiClient.get(
+        `/collections/id/${collectionId}`
+      );
+      return data;
+    });
+  }
 };
 var products_default = Products;
 

package/dist/index.mjs

@@ -127,6 +127,29 @@ var Checkout = class {
       return data;
     });
   }
+  /**
+   * Update a checkout session
+   */
+  applyDiscountCode(checkoutId, discountCode) {
+    return __async(this, null, function* () {
+      const data = yield this.apiClient.post(
+        `/checkout/${checkoutId}/discount`,
+        { code: discountCode }
+      );
+      return data;
+    });
+  }
+  /**
+   * Update a checkout session
+   */
+  revalidateDiscounts(checkoutId) {
+    return __async(this, null, function* () {
+      const data = yield this.apiClient.get(
+        `/checkout/${checkoutId}/revalidate-discounts`
+      );
+      return data;
+    });
+  }
   /**
    * Get shipping rates for a checkout session
    */
@@ -184,6 +207,31 @@ var Client = class {
       return data;
     });
   }
+  /**
+   * Update a checkout session
+   */
+  applyDiscountCode(clientSecret, checkoutId, discountCode) {
+    return __async(this, null, function* () {
+      const apiClient = createApiClient(clientSecret, this.proxy);
+      const data = yield apiClient.post(
+        `/checkout/${checkoutId}/discount`,
+        { code: discountCode }
+      );
+      return data;
+    });
+  }
+  /**
+   * Update a checkout session
+   */
+  revalidateDiscounts(clientSecret, checkoutId) {
+    return __async(this, null, function* () {
+      const apiClient = createApiClient(clientSecret, this.proxy);
+      const data = yield apiClient.get(
+        `/checkout/${checkoutId}/revalidate-discounts`
+      );
+      return data;
+    });
+  }
   /**
    * Get shipping rates for a checkout session
    */
@@ -433,6 +481,22 @@ var Products = class {
       return data;
     });
   }
+  retrieveCollectionBySeoHandle(collectionSeoHandle) {
+    return __async(this, null, function* () {
+      const data = yield this.apiClient.get(
+        `/collections/${collectionSeoHandle}`
+      );
+      return data;
+    });
+  }
+  retrieveCollectionById(collectionId) {
+    return __async(this, null, function* () {
+      const data = yield this.apiClient.get(
+        `/collections/id/${collectionId}`
+      );
+      return data;
+    });
+  }
 };
 var products_default = Products;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@betterstore/sdk",
-  "version": "0.3.48",
+  "version": "0.3.50",
   "description": "E-commerce for Developers",
   "private": false,
   "publishConfig": {