commerce-sdk - npm Package Versions

published 1.4.5-beta.0 • 4 years ago

Changelog

v1.4.5-beta.0

API Changes

Shopper APIs

Shopper Baskets API

New endpoints

| Endpoint Name | Description | | ------------- |-------------| | addTaxForBasket | Enables external taxation for the specified basket | | addTaxForBasketItem | Add tax items in external tax mode | | getTaxesFromBasket | Retrieves taxes for specified basket |

Shopper Orders API

New endpoints

| Endpoint Name | Description | | ------------- |-------------| | getTaxesFromOrder | Retrieves external taxes for the specified order |

Bug Fixes

Fixed default cache issue when the HTTP response is large

1.4.4-beta.0

published 1.4.4-beta.0 • 5 years ago

Changelog

v1.4.4-beta.0

API Changes

Einstein APIs have been removed from the SDK.

Core Functionality

Exposed logger configuration to user

import { sdkLogger } from "@commerce-sdk"

sdkLogger.setLevel(sdkLogger.levels.INFO);

User-agent now defaults to commerce-sdk@${VERSION}
Retry settings has been exposed. README.md has more details. Example:

    productClient = new Product({
      retrySettings: {
        // This means 3 total calls are made
        retries: 2,
        // Max wait between retries
        maxTimeout: 200,
        // Min wait between retries
        minTimeout: 100
      }
    }

Exchange connector has been removed from the commerce-sdk repository
Method prototype documentation has been improved

1.4.1-beta.0

published 1.4.1-beta.0 • 5 years ago

Changelog

v1.4.1-beta.0

API Changes

Product APIs

Customer API

BREAKING: Removed endpoint method changes

Removed:
- getCustomerList

Product API

BREAKING: Endpoint method name changes

Changed:

| Existing Method Name | New Method Name | | ------------- |-------------| | deleteVariationGroupForMaster | unassignVariationGroupFromMasterProduct | | updateVariationGroupInMasterProduct | updateVariationGroupForMasterProduct | | assignVariationGroupForMasterProduct | assignVariationGroupToMasterProduct | | deleteVariationForMaster | unassignVariationFromMasterProduct | | updateVariationsInMasterProduct | updateVariationForMasterProduct | | createVariationForMasterProduct | assignVariationForMasterProduct |

Shopper Customer API

BREAKING: Removed endpoint method changes

Removed:
- getCustomerAddresses
- getCustomerPaymentInstruments
- getCustomerProductListItems
  
  Changed:
  
  | Existing Method Name | New Method Name | | ------------- |-------------| | postResetPasswordToken | getResetPasswordToken |

Core Functionality

Enhancements

SDK does not set TTL for cached assets based on the HTTP headers
Added logging capability
Exchange Connector is deprecated on commerce-sdk in favor of the raml-toolkit
Examples of client instantiations have been added to APICLIENTS.md

1.4.0-beta.0

published 1.4.0-beta.0 • 5 years ago

Changelog

v1.4.0-beta.0

Core Functionality

Enhancements

Added support for Redis cache Example:

import { CacheManagerRedis } from "@commerce-apps/core"

const cacheManager = new CacheManagerRedis({ connection: "redis://localhost:6379" });
const config = {
    cacheManager: cacheManager,
    parameters: {
...
    }
}

API Changes

Product APIs

Product API

BREAKING: Endpoint method name changes

| Existing Method Name | New Method Name | | ------------- |-------------| | deleteVariationGroupForMaster | unassignVariationGroupFromMasterProduct | | updateVariationGroupInMasterProduct | updateVariationGroupForMasterProduct | | assignVariationGroupForMasterProduct | assignVariationGroupToMasterProduct | | deleteVariationForMaster | unassignVariationFromMasterProduct | | updateVariationsInMasterProduct | updateVariationForMasterProduct | | createVariationForMasterProduct | assignVariationForMasterProduct |

1.3.1-alpha.0

published 1.3.1-alpha.0 • 5 years ago

Changelog

v1.3.1-alpha.0

Core Functionality

Enhancements

Request body of the endpoints now have data types Example:

updateOrder(
        options: {
          parameters?: {
            organizationId?: string
            orderNo: string
            siteId?: string
          },
          headers?: { [key: string]: string },
          body: OrderUpdateRequestT
        }
      ): Promise<void>;

1.3.0-alpha.9

published 1.3.0-alpha.9 • 5 years ago

Changelog

v1.3.0-alpha.9

Core Functionality

Authentication helper changes

ShopperToken now contains customer info from auth response
- Potentially breaking if you are currently instantiating a ShopperToken yourself

Enhancements

SDK now returns the cached asset on HTTP 304 response
SDK now closes the network connection by default
- It can be kept open by passing a Connection header set to keep-alive

Parameters in API methods now have specific data types

Example:

productSearch(
    options?: {
        parameters?: {
        organizationId?: string
        siteId?: string
        q?: string
        refine?: Array<string>
        sort?: string
        currency?: string
        locale?: string
        offset?: number
        limit?: number
        },
        headers?: { [key: string]: string }
    }
): Promise<ProductSearchResultT>;

Documentation

VERSION.md has been renamed to APICLIENTS.md
- APICLIENTS.md now links to developer.commercecloud.com

API Changes

CDN APIs

CDN Zones/CDN API

BREAKING: API client CdnApi has been renamed to CdnZones
BREAKING: Endpoint method name changes

| Existing Method Name | New Method Name | | ------------- |-------------| | getZoneInfo | getZonesInfo | | updateWafGroupById | updateWafGroup | | updateWafRuleById | updateWafRule | | updateFirewallRuleById | updateFirewallRule |

1.3.0-alpha.8

published 1.3.0-alpha.8 • 5 years ago

Changelog

v1.3.0-alpha.8

Core Functionality

Authentication helper changes

BREAKING: helpers.getAuthToken method is replaced by helpers.getShopperToken
helpers.getShopperToken supports Client Configuration. Refer to [Sample Code](./README.md#Sample Code)

API Clients

BREAKING: API client MUST be instantiated using API name, e.g. new Product.ShopperProduct(clientConfig)

Endpoint Methods

BREAKING: Raw response option has been moved out of the options
Each endpoint now has overloaded method to return raw response

Additional Properties

Unrestricted type definitions now accepts additonal properties
Refer to this article to learn about additional properties

API Changes

Shopper Baskets

Checkout/ShopperBaskets

BREAKING: Endpoint method name changes

| Existing Method Name | New Method Name | | ------------- |-------------| | postBaskets | createBasket | | deleteBasketsById | deleteBasket | | getBasketsById | getBasket | | patchBasketsById | updateBasket | | putBasketsByIdBillingAddress | updateBillingAddressForBasket | | postBasketsByIdCoupons | addCouponToBasket | | deleteBasketsByIdCouponsById | removeCouponFromBasket | | putBasketsByIdCustomer | updateCustomerForBasket | | postBasketsByIdGiftCertificateItems | addGiftCertificateItemToBasket | | deleteBasketsByIdGiftCertificateItemsById | removeGiftCertificateItemFromBasket | | postBasketsByIdItems | addItemToBasket | | deleteBasketsByIdItemsById | removeItemFromBasket | | patchBasketsByIdItemsById | updateItemInBasket | | postBasketsByIdPaymentInstruments | addPaymentInstrumentToBasket | | deleteBasketsByIdPaymentInstrumentsById | removePaymentInstrumentFromBasket | | getBasketsByIdPaymentMethods | getPaymentMethodsForBasket | | postBasketsByIdShipments | createShipmentForBasket | | deleteBasketsByIdShipmentsById | removeShipmentFromBasket | | patchBasketsByIdShipmentsById | updateShipmentForBasket | | putBasketsByIdShipmentsByIdShippingAddress | updateShippingAddressForShipment | | putBasketsByIdShipmentsByIdShippingMethod | updateShippingMethodForShipment | | getBasketsByIdShipmentsByIdShippingMethods | getShippingMethodsForShipment |

Shopper Orders

Checkout/ShopperOrders

BREAKING: Endpoint method name changes

| Existing Method Name | New Method Name | | ------------- |-------------| | postOrders | createOrder | | getOrdersById | getOrder | | postOrdersByIdPaymentInstruments | createPaymentInstrumentForOrder | | deleteOrdersByIdPaymentInstrumentsById | removePaymentInstrumentFromOrder | | patchOrdersByIdPaymentInstrumentsById | updatePaymentInstrumentForOrder | | getOrdersByIdPaymentMethods | getPaymentMethodsForOrder |

Einstein Recommendations

AI/EinsteinQuickStartGuide

Recommender type has a new recommenderType attribute
RecommendationsResponse type has a new recoUUID attribute
ZoneResponse type has a new recoUUID attribute
Added new Recommendation type

Coupons

Pricing/Coupons

getCoupon now has an optional query parameter of "expand" which accepts an array of related attributes

1.3.0-alpha.7

published 1.3.0-alpha.7 • 5 years ago

Changelog

v1.3.0-alpha.7

Shopper Search

Search/ShopperSearch

BREAKING refine_n query parameters have been removed from productSearch
productSearch now has a query parameter of "refine" which accepts an array of refinements

Shopper Stores

Seller/ShopperStores

Now uses updated standards so 'limit' is no longer a required parameter for paginated endpoints
Max limit for paginated endpoints increased from 50 to 200

1.3.0-alpha.6

published 1.3.0-alpha.6 • 5 years ago

Changelog