sfcc-dev-mcp 1.0.19 → 1.0.21

package/docs/dw_order/TaxMgr.md

@@ -1,227 +0,0 @@
-## Package: dw.order
-
-# Class TaxMgr
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.order.TaxMgr
-
-## Description
-
-Provides methods to access the tax table.
-
-## Constants
-
-### TAX_POLICY_GROSS
-
-**Type:** Number = 0
-
-Constant representing the gross taxation policy.
-
-### TAX_POLICY_NET
-
-**Type:** Number = 1
-
-Constant representing the net taxation policy.
-
-## Properties
-
-### customRateTaxClassID
-
-**Type:** String (Read Only)
-
-The ID of the tax class that represents items with a custom tax rate. The standard order calculation
- process assumes that such line items are initialized with a tax rate and a being ignored during the tax rate
- lookup sequence of the calculation process.
- 
- Note that this tax class does not appear in the Business Manager tax module.
-
-### defaultTaxClassID
-
-**Type:** String (Read Only)
-
-The ID of the default tax class defined for the site. This class might be used in case a product or
- service does not define a tax class. 
- If no default tax class is defined, the method returns null.
-
-### defaultTaxJurisdictionID
-
-**Type:** String (Read Only)
-
-The ID of the default tax jurisdiction defined for the site. This jurisdiction might be used in case no
- jurisdiction is defined for a specific address. 
- If no default tax jurisdiction is defined, this method returns null.
-
-### taxationPolicy
-
-**Type:** Number (Read Only)
-
-The taxation policy (net/gross) configured for the current site.
-
-### taxExemptTaxClassID
-
-**Type:** String (Read Only)
-
-The ID of the tax class that represents tax exempt items. The tax manager will return a tax rate of 0.0
- for this tax class.
- 
- Note that this tax class does not appear in the Business Manager tax module.
-
-## Constructor Summary
-
-## Method Summary
-
-### applyExternalTax
-
-**Signature:** `static applyExternalTax(basket : Basket) : void`
-
-Applies externally set tax rates to the given Basket.
-
-### getCustomRateTaxClassID
-
-**Signature:** `static getCustomRateTaxClassID() : String`
-
-Returns the ID of the tax class that represents items with a custom tax rate.
-
-### getDefaultTaxClassID
-
-**Signature:** `static getDefaultTaxClassID() : String`
-
-Returns the ID of the default tax class defined for the site.
-
-### getDefaultTaxJurisdictionID
-
-**Signature:** `static getDefaultTaxJurisdictionID() : String`
-
-Returns the ID of the default tax jurisdiction defined for the site.
-
-### getTaxationPolicy
-
-**Signature:** `static getTaxationPolicy() : Number`
-
-Returns the taxation policy (net/gross) configured for the current site.
-
-### getTaxExemptTaxClassID
-
-**Signature:** `static getTaxExemptTaxClassID() : String`
-
-Returns the ID of the tax class that represents tax exempt items.
-
-### getTaxJurisdictionID
-
-**Signature:** `static getTaxJurisdictionID(location : ShippingLocation) : String`
-
-Returns the ID of the tax jurisdiction for the specified address.
-
-### getTaxRate
-
-**Signature:** `static getTaxRate(taxClassID : String, taxJurisdictionID : String) : Number`
-
-Returns the tax rate defined for the specified combination of tax class and tax jurisdiction.
-
-## Method Detail
-
-## Method Details
-
-### applyExternalTax
-
-**Signature:** `static applyExternalTax(basket : Basket) : void`
-
-**Description:** Applies externally set tax rates to the given Basket. Only use when LineItemCtnr.isExternallyTaxed() returns true. Note: a basket can only be created in EXTERNAL tax mode using SCAPI. Typical usage in tax calculation: var TaxMgr = require('dw/order/TaxMgr'); calculateTaxes: function () { Basket basket = BasketMgr.getCurrentBasket(); if ( basket.isExternallyTaxed() ) { TaxMgr.applyExternalTaxation( basket ); } else { // calculation with tax tables or customization } }
-
-**Parameters:**
-
-- `basket`: apply external taxation to this basket
-
----
-
-### getCustomRateTaxClassID
-
-**Signature:** `static getCustomRateTaxClassID() : String`
-
-**Description:** Returns the ID of the tax class that represents items with a custom tax rate. The standard order calculation process assumes that such line items are initialized with a tax rate and a being ignored during the tax rate lookup sequence of the calculation process. Note that this tax class does not appear in the Business Manager tax module.
-
----
-
-### getDefaultTaxClassID
-
-**Signature:** `static getDefaultTaxClassID() : String`
-
-**Description:** Returns the ID of the default tax class defined for the site. This class might be used in case a product or service does not define a tax class. If no default tax class is defined, the method returns null.
-
-**Returns:**
-
-the ID of the default tax class defined for the site or null.
-
----
-
-### getDefaultTaxJurisdictionID
-
-**Signature:** `static getDefaultTaxJurisdictionID() : String`
-
-**Description:** Returns the ID of the default tax jurisdiction defined for the site. This jurisdiction might be used in case no jurisdiction is defined for a specific address. If no default tax jurisdiction is defined, this method returns null.
-
-**Returns:**
-
-the ID of the default tax jurisdiction defined for the site or null.
-
----
-
-### getTaxationPolicy
-
-**Signature:** `static getTaxationPolicy() : Number`
-
-**Description:** Returns the taxation policy (net/gross) configured for the current site.
-
-**Returns:**
-
-Taxation policy configured for current site
-
-**See Also:**
-
-TAX_POLICY_GROSS
-TAX_POLICY_NET
-
----
-
-### getTaxExemptTaxClassID
-
-**Signature:** `static getTaxExemptTaxClassID() : String`
-
-**Description:** Returns the ID of the tax class that represents tax exempt items. The tax manager will return a tax rate of 0.0 for this tax class. Note that this tax class does not appear in the Business Manager tax module.
-
----
-
-### getTaxJurisdictionID
-
-**Signature:** `static getTaxJurisdictionID(location : ShippingLocation) : String`
-
-**Description:** Returns the ID of the tax jurisdiction for the specified address. If no tax jurisdiction defined for the site matches the specified address, this method returns null.
-
-**Parameters:**
-
-- `location`: The shipping location
-
-**Returns:**
-
-the ID of the tax jurisdiction for the specified address or null.
-
----
-
-### getTaxRate
-
-**Signature:** `static getTaxRate(taxClassID : String, taxJurisdictionID : String) : Number`
-
-**Description:** Returns the tax rate defined for the specified combination of tax class and tax jurisdiction. Method returns null if no tax rate is defined. Method returns 0.0 of 'nontaxable' tax rate is specified (see method 'getNontaxableTaxClassID'.
-
-**Parameters:**
-
-- `taxClassID`: ID of the tax class
-- `taxJurisdictionID`: ID of tax jusrisdiction
-
-**Returns:**
-
-the tax rate defined for the specified combination of tax class and tax jurisdiction.
-
----

package/docs/dw_order/TrackingInfo.md

@@ -1,312 +0,0 @@
-## Package: dw.order
-
-# Class TrackingInfo
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.object.Extensible
-  - dw.order.TrackingInfo
-
-## Description
-
-Provides basic information about a tracking info. An instance is identified by an ID and can be referenced from n ShippingOrderItems using TrackingRefs. This also allows one ShippingOrderItem to be associated with n TrackingInfo.
-
-## Properties
-
-### carrier
-
-**Type:** String
-
-Get the Carrier.
-
-### carrierService
-
-**Type:** String
-
-Get the service(ship method) of the used carrier.
-
-### ID
-
-**Type:** String (Read Only)
-
-Get the mandatory identifier for this tracking information. The id allows the tracking information to be referenced from
- TrackingRefs. To support short shipping a shipping-order-item can manage a list of
- TrackingRefs, each with an optional quantity value allowing individual items to ship in multiple
- parcels with known item quantity in each.
-
-### shipDate
-
-**Type:** Date
-
-Get the ship date.
-
-### shippingOrder
-
-**Type:** ShippingOrder (Read Only)
-
-Gets the shipping order.
-
-### trackingNumber
-
-**Type:** String
-
-Get the tracking number.
-
-### trackingRefs
-
-**Type:** Collection (Read Only)
-
-Gets the tracking refs (shipping order items) which are assigned to this tracking info.
-
-### warehouseID
-
-**Type:** String
-
-Get the id of the shipping warehouse.
-
-## Constructor Summary
-
-## Method Summary
-
-### getCarrier
-
-**Signature:** `getCarrier() : String`
-
-Get the Carrier.
-
-### getCarrierService
-
-**Signature:** `getCarrierService() : String`
-
-Get the service(ship method) of the used carrier.
-
-### getID
-
-**Signature:** `getID() : String`
-
-Get the mandatory identifier for this tracking information.
-
-### getShipDate
-
-**Signature:** `getShipDate() : Date`
-
-Get the ship date.
-
-### getShippingOrder
-
-**Signature:** `getShippingOrder() : ShippingOrder`
-
-Gets the shipping order.
-
-### getTrackingNumber
-
-**Signature:** `getTrackingNumber() : String`
-
-Get the tracking number.
-
-### getTrackingRefs
-
-**Signature:** `getTrackingRefs() : Collection`
-
-Gets the tracking refs (shipping order items) which are assigned to this tracking info.
-
-### getWarehouseID
-
-**Signature:** `getWarehouseID() : String`
-
-Get the id of the shipping warehouse.
-
-### setCarrier
-
-**Signature:** `setCarrier(carrier : String) : void`
-
-Set the Carrier.
-
-### setCarrierService
-
-**Signature:** `setCarrierService(carrierService : String) : void`
-
-Set the service(ship method) of the used carrier.
-
-### setShipDate
-
-**Signature:** `setShipDate(shipDate : Date) : void`
-
-Set the ship date.
-
-### setTrackingNumber
-
-**Signature:** `setTrackingNumber(trackingNumber : String) : void`
-
-Set the TrackingNumber.
-
-### setWarehouseID
-
-**Signature:** `setWarehouseID(warehouseID : String) : void`
-
-Set the id of the shipping warehouse.
-
-## Method Detail
-
-## Method Details
-
-### getCarrier
-
-**Signature:** `getCarrier() : String`
-
-**Description:** Get the Carrier.
-
-**Returns:**
-
-the Carrier
-
----
-
-### getCarrierService
-
-**Signature:** `getCarrierService() : String`
-
-**Description:** Get the service(ship method) of the used carrier.
-
-**Returns:**
-
-the carrier service (ship method)
-
----
-
-### getID
-
-**Signature:** `getID() : String`
-
-**Description:** Get the mandatory identifier for this tracking information. The id allows the tracking information to be referenced from TrackingRefs. To support short shipping a shipping-order-item can manage a list of TrackingRefs, each with an optional quantity value allowing individual items to ship in multiple parcels with known item quantity in each.
-
-**Returns:**
-
-the id
-
-**See Also:**
-
-ShippingOrder.addTrackingInfo(String)
-
----
-
-### getShipDate
-
-**Signature:** `getShipDate() : Date`
-
-**Description:** Get the ship date.
-
-**Returns:**
-
-the ship date
-
----
-
-### getShippingOrder
-
-**Signature:** `getShippingOrder() : ShippingOrder`
-
-**Description:** Gets the shipping order.
-
-**Returns:**
-
-the shipping order
-
----
-
-### getTrackingNumber
-
-**Signature:** `getTrackingNumber() : String`
-
-**Description:** Get the tracking number.
-
-**Returns:**
-
-the TrackingNumber
-
----
-
-### getTrackingRefs
-
-**Signature:** `getTrackingRefs() : Collection`
-
-**Description:** Gets the tracking refs (shipping order items) which are assigned to this tracking info.
-
-**Returns:**
-
-the tracking refs (shipping order items) which are assigned to this tracking info.
-
----
-
-### getWarehouseID
-
-**Signature:** `getWarehouseID() : String`
-
-**Description:** Get the id of the shipping warehouse.
-
-**Returns:**
-
-the id of the shipping warehouse
-
----
-
-### setCarrier
-
-**Signature:** `setCarrier(carrier : String) : void`
-
-**Description:** Set the Carrier.
-
-**Parameters:**
-
-- `carrier`: the Carrier
-
----
-
-### setCarrierService
-
-**Signature:** `setCarrierService(carrierService : String) : void`
-
-**Description:** Set the service(ship method) of the used carrier.
-
-**Parameters:**
-
-- `carrierService`: the carrier service, eg. the ship method
-
----
-
-### setShipDate
-
-**Signature:** `setShipDate(shipDate : Date) : void`
-
-**Description:** Set the ship date.
-
-**Parameters:**
-
-- `shipDate`: the ship date
-
----
-
-### setTrackingNumber
-
-**Signature:** `setTrackingNumber(trackingNumber : String) : void`
-
-**Description:** Set the TrackingNumber.
-
-**Parameters:**
-
-- `trackingNumber`: the TrackingNumber
-
----
-
-### setWarehouseID
-
-**Signature:** `setWarehouseID(warehouseID : String) : void`
-
-**Description:** Set the id of the shipping warehouse.
-
-**Parameters:**
-
-- `warehouseID`: the id of the shipping warehouse
-
----

package/docs/dw_order/TrackingRef.md

@@ -1,113 +0,0 @@
-## Package: dw.order
-
-# Class TrackingRef
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.order.TrackingRef
-
-## Description
-
-Provides basic information about the TrackingInfo a ShippingOrderItem is contained.
-
-## Properties
-
-### quantity
-
-**Type:** Quantity
-
-Gets the quantity, the shipping order item is assigned to the tracking
- info.
-
-### shippingOrderItem
-
-**Type:** ShippingOrderItem (Read Only)
-
-Gets the shipping order item which is assigned to the tracking info.
-
-### trackingInfo
-
-**Type:** TrackingInfo (Read Only)
-
-Gets the tracking info, the shipping order item is assigned to.
-
-## Constructor Summary
-
-## Method Summary
-
-### getQuantity
-
-**Signature:** `getQuantity() : Quantity`
-
-Gets the quantity, the shipping order item is assigned to the tracking info.
-
-### getShippingOrderItem
-
-**Signature:** `getShippingOrderItem() : ShippingOrderItem`
-
-Gets the shipping order item which is assigned to the tracking info.
-
-### getTrackingInfo
-
-**Signature:** `getTrackingInfo() : TrackingInfo`
-
-Gets the tracking info, the shipping order item is assigned to.
-
-### setQuantity
-
-**Signature:** `setQuantity(quantity : Quantity) : void`
-
-Sets the quantity, the shipping order item is assigned to the tracking info.
-
-## Method Detail
-
-## Method Details
-
-### getQuantity
-
-**Signature:** `getQuantity() : Quantity`
-
-**Description:** Gets the quantity, the shipping order item is assigned to the tracking info.
-
-**Returns:**
-
-the quantity the shipping order item is assigned to the tracking info.
-
----
-
-### getShippingOrderItem
-
-**Signature:** `getShippingOrderItem() : ShippingOrderItem`
-
-**Description:** Gets the shipping order item which is assigned to the tracking info.
-
-**Returns:**
-
-the shipping order item
-
----
-
-### getTrackingInfo
-
-**Signature:** `getTrackingInfo() : TrackingInfo`
-
-**Description:** Gets the tracking info, the shipping order item is assigned to.
-
-**Returns:**
-
-the tracking info
-
----
-
-### setQuantity
-
-**Signature:** `setQuantity(quantity : Quantity) : void`
-
-**Description:** Sets the quantity, the shipping order item is assigned to the tracking info.
-
-**Parameters:**
-
-- `quantity`: the quantity, the shipping order item is assigned to the tracking info.
-
----

package/docs/dw_order.hooks/BasketMergeHooks.md

@@ -1,42 +0,0 @@
-## Package: dw.order.hooks
-
-# Class BasketMergeHooks
-
-## Inheritance Hierarchy
-
-- dw.order.hooks.BasketMergeHooks
-
-## Description
-
-This interface represents all script hooks that can be registered to merge baskets. It contains the extension points (hook names), and the functions that are called by each extension point. A function must be defined inside a JavaScript source and must be exported. The script with the exported hook function must be located inside a site cartridge. Inside the site cartridge a 'package.json' file with a 'hooks' entry must exist. "hooks": "./hooks.json" The hooks entry links to a json file, relative to the 'package.json' file. This file lists all registered hooks inside the hooks property: "hooks": [ {"name": "dw.order.mergeBasket", "script": "./mergeBasket.js"} ] A hook entry has a 'name' and a 'script' property. The 'name' contains the extension point, the hook name. The 'script' contains the script relative to the hooks file, with the exported hook function.
-
-## Constants
-
-## Properties
-
-## Constructor Summary
-
-## Method Summary
-
-### mergeBasket
-
-**Signature:** `mergeBasket(source : Basket, currentBasket : Basket) : Status`
-
-Merges contents from a source basket (usually a former registered shopper's basket) to a destination basket (usually a former guest shopper basket that was transferred to the registered shopper upon login).
-
-## Method Detail
-
-## Method Details
-
-### mergeBasket
-
-**Signature:** `mergeBasket(source : Basket, currentBasket : Basket) : Status`
-
-**Description:** Merges contents from a source basket (usually a former registered shopper's basket) to a destination basket (usually a former guest shopper basket that was transferred to the registered shopper upon login). In case of no implementation is registered, the default implementation is invoked. This method is automatically called for the following scenarios: After a successful call to the transfer Rest API with query parameter merge=true, whereby the guest and registered users, both had an active basket attached. In this scenario the registered shopper's basket will be the source of the merge and the transferred guest shopper's basket will be the destination.
-
-**Parameters:**
-
-- `source`: the basket from which data should be merged into the destination, can be null e.g. in case the former guest shopper did not create a basket
-- `currentBasket`: the destination basket to merge data into
-
----