import { SDKParams } from '../types/SDKParams'; import { CartClient } from './CartClient'; import { CollectionClient } from './CollectionClient'; import { InventoryUnitClient } from './InventoryUnitClient'; import { OrderClient } from './OrderClient'; import { ProductClient } from './ProductClient'; export declare class Zecko { /** * @ignore */ readonly accessToken: string; readonly collectionClient: CollectionClient; readonly productClient: ProductClient; readonly cartClient: CartClient; readonly orderClient: OrderClient; readonly inventoryUnitClient: InventoryUnitClient; /** * * @param sdkParams Pass your accessToken here. *
*

Usage examples:

*

Collections

* Get All Collections *

* * ``` * const zecko = new Zecko({ accessToken: 'YOUR_ACCESS_TOKEN' }); * return zecko.collectionClient.getAll(); * ``` * * Get Collection by ID * * ``` * const zecko = new Zecko({ accessToken: 'YOUR_ACCESS_TOKEN' }); * return zecko.collectionClient.getById('YOUR_COLLECTION_ID'); * ``` *

Products

* Get All Products *

* * ``` * const zecko = new Zecko({ accessToken: 'YOUR_ACCESS_TOKEN' }); * return zecko.productClient.getAllByCollectionId('YOUR_COLLECTION_ID'); * ``` * * Get Product by ID * * ``` * const zecko = new Zecko({ accessToken: 'YOUR_ACCESS_TOKEN' }); * return zecko.productClient.getById('YOUR_PRODUCT_ID'); * ``` * *

Cart

* Get Cart by Customer ID *

* * ``` * const zecko = new Zecko({ accessToken: 'YOUR_ACCESS_TOKEN' }); * return zecko.cartClient.getByCustomerId('YOUR_CUSTOMER_ID'); * ``` * * Add to Cart * * ``` * const zecko = new Zecko({ accessToken: 'YOUR_ACCESS_TOKEN' }); * return zecko.cartClient.addToCart({ * customerId: 'YOUR_CUSTOMER_ID', * variantId: 'YOUR_PRODUCT_VARIANT_ID', * quantity: 'YOUR_PRODUCT_VARIANT_QUANTITY' * }); * ``` * * Delete from Cart * * ``` * const zecko = new Zecko({ accessToken: 'YOUR_ACCESS_TOKEN' }); * return zecko.cartClient.deleteFromCart({ * customerId: 'YOUR_CUSTOMER_ID', * variantId: 'YOUR_PRODUCT_VARIANT_ID', * quantity: 'YOUR_PRODUCT_VARIANT_QUANTITY' * }); * ``` * * Update by ID * * ``` * const zecko = new Zecko({ accessToken: 'YOUR_ACCESS_TOKEN' }); * return zecko.cartClient.updateById('YOUR_CART_ID', { * customer: { * email: 'YOUR_CUSTOMER_EMAIL_ADDRESS', * }, * shippingAddress: { * address1: 'YOUR_CUSTOMER_ADDRESS', // For Street address or PO Box number * address2: 'YOUR_CUSTOMER_ADDRESS', // Optional Field, For Apartment Details * city: 'YOUR_CUSTOMER_CITY', * country: 'YOUR_CUSTOMER_COUNTRY', // Optional Field * countryCode: 'YOUR_CUSTOMER_COUNTRY_CODE', // Optional Field * firstName: 'YOUR_CUSTOMER_FIRST_NAME', * lastName: 'YOUR_CUSTOMER_LAST_NAME', // Optional Field * phone: 'YOUR_CUSTOMER_PHONE_NUMBER', * province: 'REGION_OF_ADDRESS', // State or district, country * zip: 'YOUR_CUSTOMER_ZIP_CODE', * }, * shippingLine: { * price: { * amount: 'PRICE_OF_SHIPPING_RATE'; * }, * title: 'TITLE_OF_SHIPPING_RATE', * }, * }); * ``` * * Add Discount by ID * * ``` * const zecko = new Zecko({ accessToken: 'YOUR_ACCESS_TOKEN' }); * return zecko.cartClient.addDiscountById('YOUR_CART_ID', { * discounts: [ * { * type: 'DISCOUNT_CODE_TYPE', * code: 'DISCOUNT_CODE', * }, * ] * }); * ``` * * Remove Discount by ID * * ``` * const zecko = new Zecko({ accessToken: 'YOUR_ACCESS_TOKEN' }); * return zecko.cartClient.removeDiscountById('YOUR_CART_ID', { * discounts: [ * { * type: 'DISCOUNT_CODE_TYPE', * code: 'DISCOUNT_CODE', * }, * ] * }); * ``` * * Complete Cart by ID * * ``` * const zecko = new Zecko({ accessToken: 'YOUR_ACCESS_TOKEN' }); * return zecko.cartClient.completeCartById('YOUR_CART_ID', { * payment: { * totalPrice: 'TOTAL_AMOUNT_OF_CART', * }, * }); * ``` * * Delete Cart by Customer ID * * ``` * const zecko = new Zecko({ accessToken: 'YOUR_ACCESS_TOKEN' }); * return zecko.cartClient.deleteCartByCustomerId('YOUR_CUSTOMER_ID'); * ``` * *

Order

* Get Order by ID *

* * ``` * const zecko = new Zecko({ accessToken: 'YOUR_ACCESS_TOKEN' }); * return zecko.orderClient.getById('YOUR_ORDER_ID'); * ``` * * Get All Orders by Customer ID * * ``` * const zecko = new Zecko({ accessToken: 'YOUR_ACCESS_TOKEN' }); * return zecko.orderClient.getAllByCustomerId('YOUR_CUSTOMER_ID'); * ``` * *

Inventory Unit

* Cancel Inventory Unit by ID *

* * ``` * const zecko = new Zecko({ accessToken: 'YOUR_ACCESS_TOKEN' }); * return zecko.inventoryUnitClient.cancelById('YOUR_INVENTORY_UNIT_ID', { * cancelReason: 'YOUR_REASON_FOR_CANCELLATION', * }); * ``` * * Return Inventory Unit by ID * * ``` * const zecko = new Zecko({ accessToken: 'YOUR_ACCESS_TOKEN' }); * return zecko.inventoryUnitClient.returnById('YOUR_INVENTORY_UNIT_ID', { * returnReason: 'YOUR_REASON_FOR_RETURN', * }); * ``` * * Exchange Inventory Unit by ID * * ``` * const zecko = new Zecko({ accessToken: 'YOUR_ACCESS_TOKEN' }); * return zecko.inventoryUnitClient.exchangeById('YOUR_INVENTORY_UNIT_ID', { * exchangeReason: 'YOUR_REASON_FOR_EXCHANGE', * }); * ``` * * Track Inventory Unit by ID * * ``` * const zecko = new Zecko({ accessToken: 'YOUR_ACCESS_TOKEN' }); * return zecko.inventoryUnitClient.trackById('YOUR_INVENTORY_UNIT_ID'); * ``` * * - All examples available at https://github.com/zeckode/zecko-js-examples/tree/main/src/examples/js
* - For detailed documentation, visit respective class docs below. */ constructor(sdkParams: SDKParams); }