@salesforce/b2c-cli 1.10.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/hooks/PaymentHooks.d.ts

@@ -0,0 +1,189 @@
+import Status = require('../../system/Status');
+import Order = require('../Order');
+import OrderPaymentInstrument = require('../OrderPaymentInstrument');
+import Invoice = require('../Invoice');
+
+/**
+ * This interface represents all script hooks that can be registered to
+ * customize the order center payment functionality. 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.payment.authorize", "script": "./authorize.js"},
+ * {"name": "dw.order.payment.validateAuthorization", "script": "./validateAuthorization.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.
+ */
+declare interface PaymentHooks {
+    /**
+     * The extension point name extensionPointAuthorize.
+     * 
+     * This hook is optional.
+     */
+    readonly extensionPointAuthorize: "dw.order.payment.authorize";
+    /**
+     * The extension point name extensionPointAuthorizeCreditCard.
+     * 
+     * This hook is optional.
+     */
+    readonly extensionPointAuthorizeCreditCard: "dw.order.payment.authorizeCreditCard";
+    /**
+     * The extension point name extensionPointCapture.
+     */
+    readonly extensionPointCapture: "dw.order.payment.capture";
+    /**
+     * The extension point name extensionPointReauthorize.
+     */
+    readonly extensionPointReauthorize: "dw.order.payment.reauthorize";
+    /**
+     * The extension point name extensionPointRefund.
+     */
+    readonly extensionPointRefund: "dw.order.payment.refund";
+    /**
+     * The extension point name extensionPointReleaseAuthorization.
+     */
+    readonly extensionPointReleaseAuthorization: "dw.order.payment.releaseAuthorization";
+    /**
+     * The extension point name extensionPointValidateAuthorization.
+     */
+    readonly extensionPointValidateAuthorization: "dw.order.payment.validateAuthorization";
+    /**
+     * The function is called by extension point extensionPointAuthorize. Custom payment authorization - modify the
+     * order as needed.
+     * 
+     * - Prerequisite: An order has been created using the data api or via the storefront.
+     * - Return Status.OK: Corresponding payment transaction is marked as authorized (usually a custom property is used for this).
+     * - Return Status.ERROR: Order is held, authorization needs to be repeated.
+     */
+    authorize(order: Order, paymentDetails: OrderPaymentInstrument): Status;
+    /**
+     * The function is called by extension point
+     * extensionPointAuthorizeCreditCard. Custom payment authorization
+     * of a credit card - modify the order as needed.
+     * 
+     * - Prerequisite: An order has been created using the data api or via the
+     * storefront.
+     * - Return Status.OK: Corresponding payment transaction is marked as
+     * authorized (usually a custom property is used for this).
+     * - Return Status.ERROR: Order is held, authorization needs to be
+     * repeated.
+     */
+    authorizeCreditCard(order: Order, paymentDetails: OrderPaymentInstrument, cvn: string): Status;
+    /**
+     * The function is called by extension point extensionPointCapture. Custom payment capture - modify the order as needed.
+     * 
+     * - Prerequisite:
+     * 
+     * [ either ] As a result of shipping (or part-shipping) a shipping -order the warehouse updates the status of the shipping-order
+     * resulting in the creation of an unpaid debit invoice (the creation of the invoice is usually handled in
+     * dw.order.hooks.ShippingOrderHooks.changeStatus).
+     * 
+     * [ or ] A unpaid debit invoice has been created using the data api.
+     * - Context: An unpaid debit invoice is passed to the payment system for capture. The capture attempt can either succeed (complete
+     * invoice amount captured) or fail. As a result the invoice status is updated by ordercenter for further processing. See dw.order.Invoice.
+     * - Hook responsibility: The hook should attempt to capture the amount located in invoice.grandTotal.grossPrice. When successful,
+     * the capture hook should also update the invoice by calling
+     * dw.order.Invoice.addCaptureTransaction
+     * which serves to record the capturedAmount and associate the invoice with the payment-transaction.
+     * - Return Status.OK: Indicates capture succeeded: Order Center sets the Invoice status to dw.order.Invoice.STATUS_PAID.
+     * - Return Status.ERROR: Indicates capture failed: Order Center sets the Invoice status to dw.order.Invoice.STATUS_FAILED for
+     * further processing.
+     * - Post processing:  When the capture hook returns with success, order center not only sets the relevant invoice status, but also
+     * sets the relevant capturedAmount values on the invoice item. Returning success means the entire invoice total has been captured, so each item
+     * within the invoice can also be marked as completely captured. Note the script implementing the hook can take responsibility for this if desired
+     * order center will not overwrite existing values, but normally the standard implementation fits. As a result each invoice item and the related
+     * order item can return a capturedAmount, useful for calculating possible refunds.
+     */
+    capture(invoice: Invoice): Status;
+    /**
+     * The function is called by extension point extensionPointReauthorize. Custom payment authorization - modify the
+     * order as needed.
+     * 
+     * - Prerequisite:
+     * 
+     * [ either ] Based on a selected dw.order.Order, a dw.order.ShippingOrder (which represents the whole or part of the order which can be shipped)
+     * is to be created ready for export to the warehouse system.
+     * 
+     * [ or ] A dw.order.ShippingOrder is to be directly created using the data api.
+     * - Context: The related order is passed to the payment hook to check its authorization has not become invalid. Two hooks are called:
+     * 
+     * a. validateAuthorization is used to check the orders authorization is still valid
+     * 
+     * b. reauthorize is called if step a. returns Error
+     * 
+     * - Return Status.OK: Corresponding payment transaction is marked as authorized (usually a custom property is used for this).
+     * If the order had been previously authorized, the custom property values may be overwritten during reauthorization.
+     * - Return Status.ERROR: Order is held, authorization needs to be repeated.
+     */
+    reauthorize(order: Order): Status;
+    /**
+     * The function is called by extension point extensionPointRefund. Custom payment refund - modify the order as needed.
+     * 
+     * - Prerequisite:
+     * 
+     * [ either ] Goods returned by the customer result in the creation of one or more return documents, resulting in the creation of an
+     * unpaid customer credit invoice (the creation of the invoice is usually handled in dw.order.hooks.ReturnHooks.changeStatus).
+     * 
+     * [ or ] An unpaid customer credit invoice is created using the data api (perhaps as a result of the creation of a customer appeasement).
+     * - Context: An unpaid credit invoice is passed to the payment system for refund. The refund attempt can either succeed (complete
+     * invoice amount refunded) or fail. As a result the invoice status is updated by ordercenter for further processing. See dw.order.Invoice.
+     * - Hook responsibility: The hook should attempt to refund the amount located in invoice.grandTotal.grossPrice. When successful,
+     * the refund hook should also update the invoice by calling
+     * dw.order.Invoice.addRefundTransaction
+     * which serves to record the refundedAmount and associate the invoice with the payment-transaction.
+     * - Return Status.OK: Indicates refund succeeded: Order Center sets the Invoice status to dw.order.Invoice.STATUS_PAID.
+     * - Return Status.ERROR: Indicates refund failed: Order Center sets the Invoice status to dw.order.Invoice.STATUS_FAILED for
+     * further processing.
+     * - Post processing:  When the refund hook returns with success, order center not only sets the relevant invoice status, but also
+     * sets the relevant refundAmount values on the invoice item. Returning success means the entire invoice total has been refunded, so each item
+     * within the invoice can also be marked as completely refunded. Note the script implementing the hook can take responsibility for this if desired
+     * order center will not overwrite existing values, but normally the standard implementation fits. As a result each invoice item and the related
+     * order item can return a refundedAmount, useful for calculating further possible refunds.
+     */
+    refund(invoice: Invoice): Status;
+    /**
+     * The function is called by extension point extensionPointReleaseAuthorization.
+     * Custom payment release authorization - modify the order as needed.
+     * 
+     * - Prerequisite: an authorized order is updated resulting in a need to release the remaining authorization. This happens when:
+     * 
+     * - order is cancelled
+     * 
+     * - order is complete after remaining order items are cancelled.
+     * - Return Status.OK - successful release authorization
+     * - Return Status.ERROR - failed release authorization
+     */
+    releaseAuthorization(order: Order): Status;
+    /**
+     * The function is called by extension point extensionPointValidateAuthorization. Custom payment authorization - modify the
+     * order as needed.
+     * 
+     * - Context: This hook is called to validate whether a payment authorization exists for the order. It should usually check:
+     * 
+     * - Whether the authorize or reauthorize hook was previously successfully executed for the order, e.g. by checking whether custom property has been previously set.
+     * 
+     * - Whether an existing authorization has expired e.g. by comparing a timestamp set on authorization with the current time.
+     * - Return Status.OK: indicates the order has a valid payment authorization.
+     * - Return Status.ERROR: indicates reauthorize should be called.
+     * See reauthorize for more details.
+     */
+    validateAuthorization(order: Order): Status;
+}
+
+export = PaymentHooks;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/hooks/ReturnHooks.d.ts

@@ -0,0 +1,274 @@
+import Return = require('../Return');
+import Status = require('../../system/Status');
+
+/**
+ * This interface represents all script hooks that can be registered to
+ * customizing the order center return resource. 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.return.createReturn",           "script": "./returns.ds"},
+ * {"name": "dw.order.return.addReturnItem",          "script": "./returns.ds"},
+ * {"name": "dw.order.return.changeStatus",           "script": "./returns.ds"},
+ * ]
+ * ```
+ * 
+ * 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.
+ * 
+ * Overview Return Functionality Business objects
+ * dw.order.ReturnCase All returns exist in the context of a
+ * dw.order.ReturnCase, each dw.order.Order can have any number
+ * of dw.order.ReturnCases.
+ * 
+ * A dw.order.ReturnCase has dw.order.ReturnCaseItems, each of
+ * which is associated with an dw.order.OrderItem (an extension to
+ * either a dw.order.ProductLineItem or a
+ * dw.order.ShippingLineItem).
+ * 
+ * Each dw.order.ReturnCaseItem defines an
+ * dw.order.ReturnCaseItem.getAuthorizedQuantity representing the
+ * maximum quantity expected to be returned. A dw.order.ReturnCaseItem
+ * may be associated with 0..n dw.order.ReturnItems -
+ * dw.order.ReturnItems are added to the dw.order.ReturnCaseItem
+ * when dw.order.Returns are created.
+ * 
+ * Either - a dw.order.ReturnCase may be used as an RMA, in which
+ * case they are created when a customer first shows a wish to return item(s).
+ * The customer then includes the RMA number with the returned item(s). The
+ * dw.order.Return created as a result is then associated with the
+ * existing dw.order.ReturnCase.
+ * 
+ * Or - a dw.order.ReturnCase is automatically created as part of
+ * the return creation, i.e. the customer returns some item(s) leading to a
+ * creation of both a dw.order.Return and an associated
+ * dw.order.ReturnCase.
+ * 
+ * The scripting api allows access to the dw.order.ReturnCases, whether
+ * the dw.order.ReturnCase is an RMA or not, and the
+ * dw.order.ReturnCase status. Both the dw.order.ReturnCaseItems
+ * and any dw.order.Returns associated with the
+ * dw.order.ReturnCase can be accessed.
+ * 
+ * A dw.order.ReturnCase has one of these status values:
+ * 
+ * - New - the dw.order.ReturnCase has been created and can be edited
+ * previous to its authorization
+ * - CONFIRMED - the dw.order.ReturnCase is CONFIRMED, can no longer
+ * be edited, no dw.order.Returns have been associated with it. Only an
+ * New- dw.order.ReturnCase can be CONFIRMED
+ * - PARTIAL_RETURNED - the dw.order.ReturnCase has been associated
+ * with at least one dw.order.Return, but is not yet complete. Only an
+ * CONFIRMED- dw.order.ReturnCase can be set to PARTIAL_RETURNED
+ * - RETURNED - the dw.order.ReturnCase has been associated with
+ * dw.order.Returns which match the expected authorized quantity. Only
+ * an CONFIRMED- or PARTIAL_RETURNED- return-case can be set to RETURNED
+ * - Cancelled - the dw.order.ReturnCase has been cancelled (only a
+ * New- or CONFIRMED- dw.order.ReturnCase can be cancelled)
+ * 
+ * dw.order.Return
+ * A dw.order.Return represents a physical customer return, and contains
+ * 1..n dw.order.ReturnItems. A dw.order.Return is associated
+ * with one dw.order.ReturnCase, and each dw.order.ReturnItem is
+ * associated with one dw.order.ReturnCaseItem and (via the
+ * dw.order.ReturnCaseItem) a single dw.order.OrderItem usually
+ * representing an dw.order.Order dw.order.ProductLineItem.
+ * 
+ * A dw.order.ReturnItem records the quantity returned.
+ * 
+ * A dw.order.Return can have one of these status values:
+ * 
+ * - NEW - the dw.order.Return is new, i.e. needs to undergo a check
+ * before it can be marked as COMPLETED
+ * - COMPLETED - the return is complete, this is a precondition for refunding
+ * the customer for a return.
+ * 
+ * Credit Invoice
+ * As a result of making a dw.order.Return, the customer may be
+ * refunded. The refund amount is held in a credit dw.order.Invoice
+ * which may be associated either with one dw.order.Return
+ * or with one dw.order.ReturnCase. The dw.order.Invoice
+ * is passed to the refund payment hook allowing custom code to handle
+ * the payment refund.
+ * 
+ * Process overview
+ * Create dw.order.ReturnCase
+ * The creation of dw.order.ReturnCases is supported using the data-api.
+ * The api supports, within the context of an dw.order.Order, the
+ * specification of an (optional) RMA-number and addition of
+ * dw.order.ReturnCaseItems for a given order-item and quantity.
+ * Authorize dw.order.ReturnCase
+ * Following its creation, a dw.order.ReturnCase needs to be CONFIRMED -
+ * an CONFIRMED dw.order.ReturnCase cannot be modified.
+ * Cancel dw.order.ReturnCase
+ * Following its creation or authorization, a dw.order.ReturnCase may be
+ * cancelled.
+ * Create dw.order.Return
+ * dw.order.Returns may be imported or created via the data-api. These
+ * apis specify an (optional) RMA allowing a dw.order.Return to be
+ * associated with a dw.order.ReturnCase, and
+ * dw.order.ReturnItems with a quantity and a key allowing them to be
+ * associated with an order-item. The process is delegated to custom scripts
+ * which control the creation of the dw.order.Return and the addition of
+ * the dw.order.ReturnItems:
+ * 
+ * Hook extensionPointCreateReturn
+ * The creation of the new dw.order.Return is delegated to the custom
+ * script when this hook is called, passing the order, and details of the
+ * dw.order.Return to be created to the script. Typically the script
+ * accesses the dw.order.ReturnCase from the order and creates the
+ * return with the provided return-number. It may also update the
+ * dw.order.Order, dw.order.ReturnCase or
+ * dw.order.Return using custom values passed in the
+ * dw.order.Return details.
+ * 
+ * `
+ * 
+ * exports.createReturn = function (order:Order, returnDetails) {
+ * 
+ * var returnNumber=returnDetails.returnNumber;
+ * 
+ * var returnCase = order.getReturnCase(returnDetails.returnCaseNumber);
+ * 
+ * var newReturn = returnCase.createReturn(returnNumber);
+ * 
+ * return newReturn;
+ * 
+ * }`
+ * 
+ * Hook extensionPointAddReturnItem
+ * This call delegates the creation of individual dw.order.ReturnItems
+ * to a custom script, passing the dw.order.Order, returnNumber,
+ * returnCaseItemId and return-item-details. Typically the script will access
+ * the dw.order.ReturnCaseItem from the order and create a new
+ * dw.order.ReturnItem for it.
+ * 
+ * `exports.addReturnItem = function (retrn:Return, returnItemDetails) {
+ * 
+ * var returnCaseItem = order.getReturnCaseItem(returnCaseItemId);
+ * 
+ * var item = returnCaseItem.createReturnItem(returnNr);
+ * 
+ * `
+ * 
+ * Hook extensionPointChangeStatus
+ * This call delegates the update of the return-status to a custom script,
+ * passing the dw.order.Order, returnNumber and new status. The custom
+ * script is responsible for setting the status and taking any other actions
+ * necessary, including the possibility of creating a credit invoice:
+ * 
+ * `changeStatus = function (retrn:Return, status) {
+ * 
+ * retrn.status=status;
+ * 
+ * `
+ * 
+ * Hook extensionPointAfterStatusChange
+ * This call delegates the update of the return-status to a custom script,
+ * passing the dw.order.Order, returnNumber and new status. The custom
+ * script is responsible for setting the status and taking any other actions
+ * necessary, including the possibility of creating a credit invoice:
+ * 
+ * `changeStatus = function (retrn:Return, status) {
+ * 
+ * retrn.status=status;
+ * 
+ * `
+ * 
+ * Order post-processing APIs (gillian) are now inactive by default and will throw
+ * an exception if accessed. Activation needs preliminary approval by Product Management.
+ * Please contact support in this case. Existing customers using these APIs are not
+ * affected by this change and can use the APIs until further notice.
+ */
+declare interface ReturnHooks {
+    /**
+     * The extension point name extensionPointAddReturnItem.
+     */
+    readonly extensionPointAddReturnItem: "dw.order.return.addReturnItem";
+    /**
+     * The extension point name extensionPointAfterStatusChange.
+     */
+    readonly extensionPointAfterStatusChange: "dw.order.return.afterStatusChange";
+    /**
+     * The extension point name extensionPointChangeStatus.
+     */
+    readonly extensionPointChangeStatus: "dw.order.return.changeStatus";
+    /**
+     * The extension point name extensionPointCreateReturn.
+     */
+    readonly extensionPointCreateReturn: "dw.order.return.createReturn";
+    /**
+     * The extension point name extensionPointNotifyStatusChange.
+     */
+    readonly extensionPointNotifyStatusChange: "dw.order.return.notifyStatusChange";
+    /**
+     * The hook provides customization in the process of assigning the returned
+     * amount, quantity etc. Here it is possible to refund differently based on
+     * the return reason code for example. Also one could correct the inventory
+     * based on the return information. Utilize
+     * dw.order.ReturnCaseItem.createReturnItem to create a new
+     * dw.order.ReturnItem.
+     */
+    addReturnItem(retrn: Return, inputData: any): Status;
+    /**
+     * Called after method changeStatus returns
+     * Status.OK. The call is made in a separate database transaction allowing
+     * the script implementation to make an independent remote call if desired.
+     */
+    afterStatusChange(retrn: Return): Status;
+    /**
+     * Responsible to change the status of a dw.order.Return: the custom
+     * script is responsible for setting the new status using
+     * dw.order.Return.setStatus.
+     * 
+     * The invoice handling should be implemented here using
+     * dw.order.Return.createInvoice or
+     * dw.order.ReturnCase.createInvoice. For example create an
+     * dw.order.Invoice for a dw.order.Return moving to status
+     * dw.order.Return.STATUS_COMPLETED.
+     */
+    changeStatus(retrn: Return, inputData: any): Status;
+    /**
+     * This hook is responsible for creating a new dw.order.Return,
+     * based on a dw.order.ReturnCase. 2 basic workflows are supported:
+     * 
+     * -
+     * On-the-fly return: create the parent dw.order.ReturnCase using
+     * dw.order.Order.createReturnCase.
+     * -
+     * Return-merchandise-authorization (RMA) workflow: resolve an existing
+     * dw.order.ReturnCase using
+     * dw.order.Order.getReturnCase.
+     * 
+     * In both cases use dw.order.ReturnCase.createReturn to create the dw.order.Return based on the inputData.
+     * 
+     * Additional functionality like creating history entry, handling the return
+     * fees or the shipping cost credit can be implemented in the hook after the
+     * dw.order.Return is created.
+     */
+    createReturn(inputData: any): Return;
+    /**
+     * Called after method changeStatus returns
+     * Status.OK (and after method afterStatusChange)
+     * to inform of a successful status change. The call is made outside any
+     * database transaction. This is the best hook in which to send customer
+     * notifications as the status change has already been successfully written
+     * to the database
+     */
+    notifyStatusChange(retrn: Return): Status;
+}
+
+export = ReturnHooks;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/hooks/ShippingOrderHooks.d.ts

@@ -0,0 +1,220 @@
+import ShippingOrder = require('../ShippingOrder');
+import Status = require('../../system/Status');
+import Order = require('../Order');
+
+/**
+ * This interface represents all script hooks that can be registered around
+ * shipping order lifecycle. 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.shippingorder.updateShippingOrderItem", "script": "./shippingOrderUpdate.ds"},
+ * ]
+ * ```
+ * 
+ * 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.
+ * 
+ * Order post-processing APIs (gillian) are now inactive by default and will throw
+ * an exception if accessed. Activation needs preliminary approval by Product Management.
+ * Please contact support in this case. Existing customers using these APIs are not
+ * affected by this change and can use the APIs until further notice.
+ */
+declare interface ShippingOrderHooks {
+    /**
+     * The extension point name extensionPointAfterStatusChange.
+     */
+    readonly extensionPointAfterStatusChange: "dw.order.shippingorder.afterStatusChange";
+    /**
+     * The extension point name extensionPointChangeStatus.
+     */
+    readonly extensionPointChangeStatus: "dw.order.shippingorder.changeStatus";
+    /**
+     * The extension point name extensionPointCreateShippingOrders.
+     */
+    readonly extensionPointCreateShippingOrders: "dw.order.shippingorder.createShippingOrders";
+    /**
+     * The extension point name extensionPointNotifyStatusChange.
+     */
+    readonly extensionPointNotifyStatusChange: "dw.order.shippingorder.notifyStatusChange";
+    /**
+     * The extension point name
+     * extensionPointPrepareCreateShippingOrders.
+     */
+    readonly extensionPointPrepareCreateShippingOrders: "dw.order.shippingorder.prepareCreateShippingOrders";
+    /**
+     * The extension point name extensionPointResolveShippingOrder .
+     */
+    readonly extensionPointResolveShippingOrder: "dw.order.shippingorder.resolveShippingOrder";
+    /**
+     * The extension point name extensionPointShippingOrderCancelled.
+     */
+    readonly extensionPointShippingOrderCancelled: "dw.order.shippingorder.setShippingOrderCancelled";
+    /**
+     * The extension point name extensionPointShippingOrderShipped.
+     */
+    readonly extensionPointShippingOrderShipped: "dw.order.shippingorder.setShippingOrderShipped";
+    /**
+     * The extension point name extensionPointShippingOrderWarehouse.
+     */
+    readonly extensionPointShippingOrderWarehouse: "dw.order.shippingorder.setShippingOrderWarehouse";
+    /**
+     * The extension point name extensionPointUpdateShippingOrderItem.
+     */
+    readonly extensionPointUpdateShippingOrderItem: "dw.order.shippingorder.updateShippingOrderItem";
+    /**
+     * After Status change hook.
+     * 
+     * The function is called by extension point
+     * extensionPointAfterStatusChange.
+     * 
+     * The implementation of this hook is optional. If defined the hook is
+     * called after extensionPointChangeStatus or respectively after
+     * extensionPointShippingOrderShipped,
+     * extensionPointShippingOrderCancelled or
+     * extensionPointShippingOrderWarehouse
+     * 
+     * Runs inside of a transaction.
+     */
+    afterStatusChange(shippingOrder: ShippingOrder): Status;
+    /**
+     * Change the status of a shipping order.
+     * 
+     * The function is called by extension point
+     * extensionPointChangeStatus.
+     * 
+     * Runs inside a transaction together with the hooks
+     * extensionPointResolveShippingOrder
+     * extensionPointUpdateShippingOrderItem.
+     * 
+     * Runs after the iteration over the input's items collection as the last
+     * step in this transaction. The implementation of this hook is mandatory.
+     */
+    changeStatus(shippingOrder: ShippingOrder, updateData: any): Status;
+    /**
+     * Called during shipping order creation for an order.
+     * 
+     * The function is called by extension point
+     * extensionPointCreateShippingOrders. It is responsible for
+     * creating shipping orders and its items for the order. Preparations for
+     * shipping order creation can be done before in hook
+     * extensionPointPrepareCreateShippingOrders.
+     * 
+     * Runs inside of a transaction. The implementation of this hook is
+     * mandatory.
+     */
+    createShippingOrders(order: Order): Status;
+    /**
+     * Notify Status change hook.
+     * 
+     * The function is called by extension point
+     * extensionPointNotifyStatusChange.
+     * 
+     * The implementation of this hook is optional. If defined the hook is
+     * called after extensionPointAfterStatusChange as the last step
+     * in the shipping order update process.
+     * 
+     * Runs outside of a transaction.
+     */
+    notifyStatusChange(shippingOrder: ShippingOrder): Status;
+    /**
+     * Called before shipping order creation for an order takes place. Typically
+     * the hook is used to check the payment authorization status of the order.
+     * 
+     * The function is called by extension point
+     * extensionPointPrepareCreateShippingOrders.
+     * 
+     * Runs inside its own transaction. The value of the return status is used
+     * to control whether hook createShippingOrders is called
+     * for the order or not. The implementation of this hook is mandatory.
+     */
+    prepareCreateShippingOrders(order: Order): Status;
+    /**
+     * Resolve the shipping order. Will be called as first step of the update.
+     * 
+     * The function is called by extension point
+     * extensionPointResolveShippingOrder.
+     * 
+     * Runs inside a transaction together with the hooks
+     * 
+     * extensionPointUpdateShippingOrderItem
+     * extensionPointChangeStatus. The implementation of this hook is
+     * mandatory.
+     */
+    resolveShippingOrder(updateData: any): ShippingOrder;
+    /**
+     * Change the status of a shipping order to cancelled.
+     * 
+     * The function is called by extension point
+     * extensionPointShippingOrderCancelled.
+     * 
+     * This is an optional hook that can be implemented to have full control
+     * over status change to destination status Cancelled. The following hooks
+     * will be skipped if an implementation for this hook is registered:
+     * extensionPointResolveShippingOrder,
+     * extensionPointUpdateShippingOrderItem,
+     * extensionPointChangeStatus.
+     * 
+     * Runs inside of a transaction.
+     */
+    setShippingOrderCancelled(updateData: any): Order;
+    /**
+     * Change the status of a shipping order to shipped.
+     * 
+     * The function is called by extension point
+     * extensionPointShippingOrderShipped.
+     * 
+     * This is an optional hook that can be implemented to have full control
+     * over status change to destination status Shipped. The following hooks
+     * will be skipped if an implementation for this hook is registered:
+     * extensionPointResolveShippingOrder
+     * extensionPointUpdateShippingOrderItem,
+     * extensionPointChangeStatus.
+     * 
+     * Runs inside of a transaction.
+     */
+    setShippingOrderShipped(updateData: any): Order;
+    /**
+     * Change the status of a shipping order to warehouse.
+     * 
+     * The function is called by extension point
+     * extensionPointShippingOrderWarehouse.
+     * 
+     * This is an optional hook that can be implemented to have full control
+     * over status change to destination status Warehouse. The following hooks
+     * will be skipped if an implementation for this hook is registered:
+     * extensionPointResolveShippingOrder,
+     * extensionPointUpdateShippingOrderItem,
+     * extensionPointChangeStatus.
+     * 
+     * Runs inside of a transaction.
+     */
+    setShippingOrderWarehouse(updateData: any): Order;
+    /**
+     * Updates the status of a shipping order item.
+     * 
+     * The function is called by extension point
+     * extensionPointUpdateShippingOrderItem.
+     * 
+     * Runs inside a transaction together with the hooks
+     * 
+     * extensionPointResolveShippingOrder
+     * extensionPointChangeStatus. The implementation of this hook is
+     * mandatory.
+     */
+    updateShippingOrderItem(shippingOrder: ShippingOrder, updateItem: any): Status;
+}
+
+export = ShippingOrderHooks;