@salesforce/b2c-cli 1.11.0 → 1.12.1

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/PipelineDictionary.d.ts

@@ -0,0 +1,28 @@
+/**
+ * The class provides access to the values in the pipeline dictionary. You use
+ * dynamic properties to access values, such as pdict.myvalue or
+ * pdict['myvalue'];
+ * 
+ * The class is used in two different contexts, one where access is limited to
+ * the declared input/output values and second to a context with full access.
+ * Inside scripts, the PipelineDictionary allows you to access declared in/out
+ * values (regardless of the alias used in the pipeline and the actual key under
+ * which the value is stored). In templates and pipelines, all values can be
+ * accessed. In templates the pipeline dictionary is exposed as variable pdict
+ * (e.g. ${pdict.Product.ID}).
+ * 
+ * There are several values that are automatically stored in the
+ * PipelineDictionary with each request. These include but are not limited to:
+ * 
+ * - CurrentSession
+ * - CurrentRequest
+ * - CurrentHttpParameterMap
+ * - CurrentForms
+ * - CurrentCustomer
+ * - etc.
+ */
+declare class PipelineDictionary {
+    private constructor();
+}
+
+export = PipelineDictionary;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/RESTErrorResponse.d.ts

@@ -0,0 +1,58 @@
+import CustomAttributes = require('../object/CustomAttributes');
+
+/**
+ * This class represents a REST error response that is compliant with
+ * RFC 9457. It can only be instantiated using the
+ * `createError` methods in RESTResponseMgr.
+ * 
+ * Here is an example:
+ * 
+ * ```
+ * `
+ * var error = RESTResponseMgr.createError(400);
+ * error.custom.foo = "bar";
+ * error.render();
+ * `
+ * ```
+ * 
+ * The above script would result in an HTTP response with status code 400 and the following body:
+ * 
+ * ```
+ * `
+ * {
+ * "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/custom-errors/bad-request",
+ * "c_foo": "bar"
+ * }
+ * `
+ * ```
+ * 
+ * NOTE:
+ * 
+ * - Custom attributes are rendered with "c_" prefix as shown in the example above.
+ * - Rendering works as described in TopLevel.JSON.stringify.
+ */
+declare class RESTErrorResponse {
+    /**
+     * Returns all the custom attributes associated with the error response object. The attributes are stored for the
+     * lifetime of the error response object.
+     */
+    readonly custom: CustomAttributes;
+    private constructor();
+    /**
+     * Returns all the custom attributes associated with the error response object. The attributes are stored for the
+     * lifetime of the error response object.
+     */
+    getCustom(): CustomAttributes;
+    /**
+     * Sends the RESTErrorResponse object as an HTTP error response to the client, adhering to
+     * RFC 9457. This method sets the "Content-Type" header to
+     * "application/problem+json", HTTP Status Code to statusCode attribute and constructs the body from type, title,
+     * detail and custom attributes of the object. Custom attributes are rendered with "c_" prefix to the attribute
+     * name.
+     * @throws IllegalStateException If the RESTErrorResponse object is already rendered.
+     * @throws Exception If there is an error while serializing the RESTErrorResponse object.
+     */
+    render(): void;
+}
+
+export = RESTErrorResponse;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/RESTResponseMgr.d.ts

@@ -0,0 +1,99 @@
+import RESTErrorResponse = require('./RESTErrorResponse');
+import RESTSuccessResponse = require('./RESTSuccessResponse');
+import RemoteInclude = require('./RemoteInclude');
+import URLParameter = require('../web/URLParameter');
+import URLAction = require('../web/URLAction');
+
+/**
+ * This class provides helper methods for creating REST error and success responses. It is mainly intended to be used to
+ * build Custom REST APIs. But, any controller implementation planning to provide REST-like responses can use these
+ * methods. If these methods are being used in the controllers, note that a few defaults like URL prefix for
+ * `type` in `createError` methods will correspond to Custom REST APIs.
+ */
+declare class RESTResponseMgr {
+    private constructor();
+    /**
+     * Constructs a new RESTSuccessResponse object. This method is to be used in scenarios where response body
+     * is not expected (e.g. statusCode is 204).
+     * @throws IllegalArgumentException If the statusCode is not in the (100..299) range.
+     */
+    static createEmptySuccess(statusCode: number): RESTSuccessResponse;
+    /**
+     * Constructs a new RESTErrorResponse object. This method should be used when you have just the statusCode
+     * of the error and want the type of error to be inferred.
+     * 
+     * 'type' of the error is inferred from the status code as follows:
+     * 
+     * - `400` - `bad-request`
+     * - `401` - `unauthorized`
+     * - `403` - `forbidden`
+     * - `404` - `resource-not-found`
+     * - `409` - `conflict`
+     * - `412` - `precondition-failed`
+     * - `429` - `too-many-requests`
+     * - `500` - `internal-server-error`
+     * - `default` - `about:blank`
+     * @throws IllegalArgumentException If the statusCode is not in the (400..599) range.
+     */
+    static createError(statusCode: number): RESTErrorResponse;
+    /**
+     * Constructs a new RESTErrorResponse object. This method should be used when you want to omit 'title' and
+     * 'detail' of the error. With this method, custom error codes and types apart from the standard ones can be
+     * constructed.
+     * @throws IllegalArgumentException If the statusCode is not in the (400..599) range or if the error type is not a valid URI or conflicts with the SYSTEM error type namespace.
+     */
+    static createError(statusCode: number, type: string): RESTErrorResponse;
+    /**
+     * Constructs a new RESTErrorResponse object. This method should be used when you want to omit 'detail' of
+     * the error but want to have valid 'statusCode', 'type' and 'title'.
+     * @throws IllegalArgumentException If the statusCode is not in the (400..599) range or if the error type is not a valid URI or conflicts with SYSTEM error type namespace.
+     */
+    static createError(statusCode: number, type: string, title: string): RESTErrorResponse;
+    /**
+     * Constructs a new RESTErrorResponse object. This method can be used to construct error responses with
+     * valid 'statusCode', 'type', 'title' and 'detail'. If you want to omit title or detail, you can pass in
+     * `null`.
+     * @throws IllegalArgumentException If the statusCode is not in the (400..599) range or if the error type is not a valid URI or conflicts with SYSTEM error type namespace.
+     */
+    static createError(statusCode: number, type: string, title: string, detail: string): RESTErrorResponse;
+    /**
+     * Constructs a new RemoteInclude object specific for the SCAPI include path.
+     * Usage:
+     * SCAPI remote include URL have following form:
+     * 
+     * ```
+     * BASE_PATH/{apiFamily}/{apiName}/{apiVersion}/organizations/ORG_ID/{resourcePath}[?params]
+     * ```
+     * 
+     * For the given SCAPI resource path:
+     * 
+     * ```
+     * BASE_PATH/product/shopper-products/v1/organizations/ORG_ID/categories/root?siteId=YourShopHere
+     * ```
+     * 
+     * RemoteInclude object can be constructed in a script like following:
+     * 
+     * ```
+     * let include = dw.system.RESTResponseMgr.createScapiRemoteInclude("product", "shopper-products", "v1", "categories/root",
+     * dw.web.URLParameter("siteId", "YourShopHere"));
+     * ```
+     * 
+     * Please notice that 'BASE_PATH' and 'ORG_ID' are automatically resolved.
+     */
+    static createScapiRemoteInclude(apiFamily: string, apiName: string, apiVersion: string, resourcePath: string, ...params: URLParameter[]): RemoteInclude;
+    /**
+     * Constructs a new RemoteInclude object specific for the Storefront Controller include path.
+     */
+    static createStorefrontControllerRemoteInclude(action: URLAction, ...params: URLParameter[]): RemoteInclude;
+    /**
+     * Constructs a new RESTSuccessResponse object.
+     * @throws IllegalArgumentException If the statusCode is not in the (100..299) range.
+     */
+    static createSuccess(body: Object, statusCode: number): RESTSuccessResponse;
+    /**
+     * Constructs a new RESTSuccessResponse object. HTTP status code of the response will be defaulted to 200.
+     */
+    static createSuccess(body: Object): RESTSuccessResponse;
+}
+
+export = RESTResponseMgr;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/RESTSuccessResponse.d.ts

@@ -0,0 +1,38 @@
+/**
+ * This class represents a REST success response that is compliant with the RFC standards. It can only be instantiated
+ * using the `createSuccess` methods in RESTResponseMgr.
+ * 
+ * Here is an example:
+ * 
+ * `
+ * var body = {"hello": "world"}
+ * 
+ * var success = RESTResponseMgr.createSuccess(body);
+ * 
+ * success.render();
+ * 
+ * `
+ * 
+ * The above script would result in an HTTP response with status code 200 and the following body:
+ * 
+ * `
+ * {
+ * 
+ *  "hello": "world"
+ * 
+ * }
+ * 
+ * `
+ */
+declare class RESTSuccessResponse {
+    private constructor();
+    /**
+     * Sends the RESTSuccessResponse object as an HTTP response to the client. This sets the "Content-Type"
+     * header to "application/json" and expects the body to be a valid JavaScript JSON object.
+     * @throws IllegalStateException If the RESTSuccessResponse object is already rendered.
+     * @throws Exception If there is an error while serializing the body.
+     */
+    render(): void;
+}
+
+export = RESTSuccessResponse;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/RemoteInclude.d.ts

@@ -0,0 +1,85 @@
+/**
+ * The class represents a remote include value that can be assigned to JSON Object properties.
+ * 
+ * Important notes:
+ * 
+ * - Authentication and authorization checks are performed only for the top
+ * level request, but NOT for remote include requests.
+ * - The `RestResponseMgr` method `createScapiRemoteInclude()` allows only SCAPI URLs.
+ * - The `RestResponseMgr` method `createStorefrontControllerRemoteInclude()` allows only Controller URLs.
+ * - Correct rendering of RemoteInclude-containing objects is only performed
+ * when processed by `dw.system.RESTSuccessResponse.render()` method. Please check the provided examples.
+ * 
+ * Example 1. Specify remote include properties.
+ * 
+ * ```
+ * function specifyRemoteIncludeProperties() {
+ * var includeValue0 = dw.system.RESTResponseMgr.createScapiRemoteInclude("custom", "sample", "v1", "resource/path/0", dw.web.URLParameter("siteId", "TestWapi"));
+ * var includeValue1 = dw.system.RESTResponseMgr.createScapiRemoteInclude("custom", "sample", "v1", "resource/path/1", dw.web.URLParameter("siteId", "TestWapi"));
+ * var greeting = { "hello": "world", "includeProperty0": includeValue0, "includeProperty1": includeValue1 };
+ * 
+ * dw.system.RESTResponseMgr.createSuccess(greeting).render();
+ * }
+ * ```
+ * 
+ * Example 2. Specify array of remote include properties.
+ * 
+ * ```
+ * function specifyArrayOfRemoteIncludes() {
+ * var includeValue0 = dw.system.RESTResponseMgr.createScapiRemoteInclude("custom", "sample", "v1", "resource/path/0", dw.web.URLParameter("siteId", "TestWapi"));
+ * var includeValue1 = dw.system.RESTResponseMgr.createScapiRemoteInclude("custom", "sample", "v1", "resource/path/1", dw.web.URLParameter("siteId", "TestWapi"));
+ * var greeting = { "hello": "world", "includeArray": [includeValue0, includeValue1] };
+ * 
+ * dw.system.RESTResponseMgr.createSuccess(greeting).render();
+ * }
+ * ```
+ * 
+ * Example 3. Storefront controller remote include.
+ * 
+ * ```
+ * function storefrontRemoteInclude()
+ * {
+ * let remoteInclude = dw.system.RESTResponseMgr.createStorefrontControllerRemoteInclude(new URLAction("Category-Show", "Sites-MyShop-Site", dw.web.URLParameter("cid", "root")));
+ * let json = {
+ * status: "JSONOK",
+ * include: remoteInclude
+ * };
+ * dw.system.RESTResponseMgr.createSuccess(json).render();
+ * }
+ * ```
+ * 
+ * Error handling:
+ * 
+ * SCAPI:
+ * 
+ * - In case of 404 response received on included resource, an empty JSON object '{}' will be supplied in final JSON.
+ * - In case of 201..299, 3xx, 4xx (excluding 404), 5xx response from included resource, final response status will be 500 'Internal Server Error'
+ * 
+ * Controllers:
+ * 
+ * - In case of any non 200 response from the included resource an empty string will be included.
+ * - Note: In case your response format is JSON be aware that this can result in invalid JSON.
+ */
+declare class RemoteInclude {
+    /**
+     * Returns the URL string value specified for the current instance.
+     */
+    readonly url: string;
+    private constructor();
+    /**
+     * Returns the URL string value specified for the current instance.
+     */
+    getUrl(): string;
+    /**
+     * Returns the URL string value specified for the current instance, same as
+     * getUrl.
+     */
+    toString(): string;
+    /**
+     * Returns the URL string value specified for the current instance, same as
+     * getUrl.
+     */
+    valueOf(): any;
+}
+
+export = RemoteInclude;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/Request.d.ts

@@ -0,0 +1,363 @@
+import Session = require('./Session');
+import Cookies = require('../web/Cookies');
+import Cookie = require('../web/Cookie');
+import utilMap = require('../util/Map');
+import URL = require('../web/URL');
+import Geolocation = require('../util/Geolocation');
+import CustomAttributes = require('../object/CustomAttributes');
+import PageMetaData = require('../web/PageMetaData');
+import HttpParameterMap = require('../web/HttpParameterMap');
+import Form = require('../web/Form');
+import FormAction = require('../web/FormAction');
+
+/**
+ * Represents a request in Commerce Cloud Digital. Each pipeline dictionary contains a CurrentRequest object, which is of
+ * type dw.system.Request. Most requests are HTTP requests, so you can use this object to get information about the HTTP
+ * request, such as the HTTP headers. You can also get a list of cookies, if any, associated with the request. If the
+ * request is issued from a job, the request is not an HTTP request, so HTTP-related methods return null.
+ */
+declare class Request {
+    /**
+     * Returns whether the request originated in SCAPI.
+     */
+    readonly SCAPI: boolean;
+    /**
+     * Returns a map containing all path parameters of current SCAPI request in the following way:
+     * 
+     * - keys: path parameter names from path pattern
+     * - values: corresponding path parameter values from current request
+     * 
+     * Returns null if isSCAPI returns false i.e. if the request is not a SCAPI request.
+     * 
+     * For example:
+     * 
+     * - Current request: `/product/shopper-products/v1/organizations/sfcc_org/products/apple-ipod-shuffle`
+     * - Path pattern: `/product/shopper-products/v1/organizations/{organizationId}/products/{id}`
+     * - Result: dw.util.Map with 2 key:value pairs: `organizationId:sfcc_org` and `id:apple-ipod-shuffle`.
+     */
+    readonly SCAPIPathParameters: utilMap<any, any> | null;
+    /**
+     * Returns the SCAPI path pattern in the following way:
+     * 
+     * - The first three segments `/api-family/api-name/version` with concrete values.
+     * - The /organizations part with the path parameter name `organizationId` in curly brackets.
+     * - The actual resource path additional path parameter names in curly brackets.
+     * 
+     * Returns null if isSCAPI returns false i.e. if the request is not a SCAPI request.
+     * 
+     * For example, in the context of a request to get a single product from shopper-products API, this method would
+     * return `/product/shopper-products/v1/organizations/{organizationId}/products/{id}`
+     */
+    readonly SCAPIPathPattern: string | null;
+    /**
+     * Returns the client id of the current SCAPI or OCAPI request. If the request is not a SCAPI request or not an
+     * OCAPI request 'null' is returned. For client ids owned by Commerce Cloud Digital an alias is returned.
+     */
+    readonly clientId: string | null;
+    /**
+     * Returns all of the custom attributes associated with the request. The attributes are stored for the life time of
+     * the request.
+     */
+    readonly custom: CustomAttributes;
+    /**
+     * Returns the physical location for the current request, if available. The
+     * location is calculated based on the IP address of the request. Note, if
+     * the geolocation tracking feature is not enabled, this method always
+     * returns null.
+     */
+    geolocation: Geolocation | null;
+    /**
+     * Returns the Cookies object, which can be used to read cookies sent by the client. Use the method
+     * `Response.addHttpCookie()` to add a cookie to the outgoing response.
+     */
+    readonly httpCookies: Cookies | null;
+    /**
+     * Returns a Map containing all HTTP header values.
+     */
+    readonly httpHeaders: utilMap<any, any>;
+    /**
+     * Returns the host name or null if there is no host name.
+     */
+    readonly httpHost: string | null;
+    /**
+     * Returns the locale or null if there is no associated locale.
+     */
+    readonly httpLocale: string | null;
+    /**
+     * Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
+     */
+    readonly httpMethod: string;
+    /**
+     * Returns the parameter map that contains the HTTP parameters for the current request.
+     */
+    readonly httpParameterMap: HttpParameterMap;
+    /**
+     * Returns a Map containing the raw HTTP parameters sent to the server. The Map contains name/value pairs. Each name
+     * is a String and each value is a String array.
+     */
+    readonly httpParameters: utilMap<any, any>;
+    /**
+     * Returns the path.
+     */
+    readonly httpPath: string | null;
+    /**
+     * Returns the HTTP protocol used for this request. Possible values are "http" or "https". If the current activity
+     * is not related to an HTTP request, for example, when the request is part of a job, this method returns null.
+     */
+    readonly httpProtocol: string | null;
+    /**
+     * Returns the query string or null if there is no query string.
+     */
+    readonly httpQueryString: string | null;
+    /**
+     * Returns the referer or null if there is no referer.
+     */
+    readonly httpReferer: string | null;
+    /**
+     * Returns the remote address or null if no remote address is found.
+     */
+    readonly httpRemoteAddress: string | null;
+    /**
+     * Identifies if this request is an HTTP request. The method returns true, if the current processing is related to a
+     * HTTP request.
+     * @deprecated Effectively always returns true.
+     */
+    readonly httpRequest: boolean;
+    /**
+     * Returns whether the HTTP communication is secure, which basically means that the communication happens via https.
+     * If the current activity is not related to an HTTP request the method returns false.
+     */
+    readonly httpSecure: boolean;
+    /**
+     * Returns the complete URL of the request which was received at the server.
+     * This URL does not include SEO optimizations.
+     */
+    readonly httpURL: URL;
+    /**
+     * Returns the HTTP user agent or null if there is no user agent.
+     */
+    readonly httpUserAgent: string | null;
+    /**
+     * Returns true if the request represents a request for a remote include, false if it is a top-level request.
+     */
+    readonly includeRequest: boolean;
+    /**
+     * Returns the locale of the current request. This locale is set by the system based on the information in the URL.
+     * It may be different from the locale returned by getHttpLocale, which is the preferred locale sent by the user agent.
+     */
+    locale: string;
+    /**
+     * Returns the OCAPI version of the current request. If this is not
+     * an OCAPI request, 'null' is returned.
+     */
+    readonly ocapiVersion: string;
+    /**
+     * Returns the page meta data that are associated with the current request.
+     */
+    readonly pageMetaData: PageMetaData;
+    /**
+     * Returns the unique identifier of the current request. The unique id is helpful for debugging purpose, e.g. relate
+     * debug messages to a particular request.
+     */
+    readonly requestID: string;
+    /**
+     * Returns the session associated with this request.
+     */
+    readonly session: Session;
+    /**
+     * Returns the form that was submitted by the client if the request represents a form submission.
+     */
+    readonly triggeredForm: Form;
+    /**
+     * Returns the form action that was triggered by the client if the request represents a form submission.
+     */
+    readonly triggeredFormAction: FormAction;
+    private constructor();
+    /**
+     * Adds the specified cookie to the outgoing response. This method can be called multiple times to set more than one
+     * cookie. If a cookie with the same cookie name, domain and path is set multiple times for the same response, only
+     * the last set cookie with this name is send to the client. This method can be used to set, update or delete
+     * cookies at the client. If the cookie doesn't exist at the client, it is set initially. If a cookie with the same
+     * name, domain and path already exists at the client, it is updated. A cookie can be deleted at the client by
+     * submitting a cookie with the maxAge attribute set to 0 (see `Cookie.setMaxAge()
+     * ` for more information).
+     * @example
+     * Example, how a cookie can be deleted at the client:
+     * 
+     * var cookie : Cookie = new Cookie("SomeName", "Simple Value");
+     * 
+     * cookie.setMaxAge(0);
+     * 
+     * request.addHttpCookie(cookie);
+     * @deprecated Use dw.system.Response.addHttpCookie instead.
+     */
+    addHttpCookie(cookie: Cookie): void;
+    /**
+     * Returns the client id of the current SCAPI or OCAPI request. If the request is not a SCAPI request or not an
+     * OCAPI request 'null' is returned. For client ids owned by Commerce Cloud Digital an alias is returned.
+     */
+    getClientId(): string | null;
+    /**
+     * Returns all of the custom attributes associated with the request. The attributes are stored for the life time of
+     * the request.
+     */
+    getCustom(): CustomAttributes;
+    /**
+     * Returns the physical location for the current request, if available. The
+     * location is calculated based on the IP address of the request. Note, if
+     * the geolocation tracking feature is not enabled, this method always
+     * returns null.
+     */
+    getGeolocation(): Geolocation | null;
+    /**
+     * Returns the Cookies object, which can be used to read cookies sent by the client. Use the method
+     * `Response.addHttpCookie()` to add a cookie to the outgoing response.
+     */
+    getHttpCookies(): Cookies | null;
+    /**
+     * Returns a Map containing all HTTP header values.
+     */
+    getHttpHeaders(): utilMap<any, any>;
+    /**
+     * Returns the host name or null if there is no host name.
+     */
+    getHttpHost(): string | null;
+    /**
+     * Returns the locale or null if there is no associated locale.
+     */
+    getHttpLocale(): string | null;
+    /**
+     * Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
+     */
+    getHttpMethod(): string;
+    /**
+     * Returns the parameter map that contains the HTTP parameters for the current request.
+     */
+    getHttpParameterMap(): HttpParameterMap;
+    /**
+     * Returns a Map containing the raw HTTP parameters sent to the server. The Map contains name/value pairs. Each name
+     * is a String and each value is a String array.
+     */
+    getHttpParameters(): utilMap<any, any>;
+    /**
+     * Returns the path.
+     */
+    getHttpPath(): string | null;
+    /**
+     * Returns the HTTP protocol used for this request. Possible values are "http" or "https". If the current activity
+     * is not related to an HTTP request, for example, when the request is part of a job, this method returns null.
+     */
+    getHttpProtocol(): string | null;
+    /**
+     * Returns the query string or null if there is no query string.
+     */
+    getHttpQueryString(): string | null;
+    /**
+     * Returns the referer or null if there is no referer.
+     */
+    getHttpReferer(): string | null;
+    /**
+     * Returns the remote address or null if no remote address is found.
+     */
+    getHttpRemoteAddress(): string | null;
+    /**
+     * Returns the complete URL of the request which was received at the server.
+     * This URL does not include SEO optimizations.
+     */
+    getHttpURL(): URL;
+    /**
+     * Returns the HTTP user agent or null if there is no user agent.
+     */
+    getHttpUserAgent(): string | null;
+    /**
+     * Returns the locale of the current request. This locale is set by the system based on the information in the URL.
+     * It may be different from the locale returned by getHttpLocale, which is the preferred locale sent by the user agent.
+     */
+    getLocale(): string;
+    /**
+     * Returns the OCAPI version of the current request. If this is not
+     * an OCAPI request, 'null' is returned.
+     */
+    getOcapiVersion(): string;
+    /**
+     * Returns the page meta data that are associated with the current request.
+     */
+    getPageMetaData(): PageMetaData;
+    /**
+     * Returns the unique identifier of the current request. The unique id is helpful for debugging purpose, e.g. relate
+     * debug messages to a particular request.
+     */
+    getRequestID(): string;
+    /**
+     * Returns a map containing all path parameters of current SCAPI request in the following way:
+     * 
+     * - keys: path parameter names from path pattern
+     * - values: corresponding path parameter values from current request
+     * 
+     * Returns null if isSCAPI returns false i.e. if the request is not a SCAPI request.
+     * 
+     * For example:
+     * 
+     * - Current request: `/product/shopper-products/v1/organizations/sfcc_org/products/apple-ipod-shuffle`
+     * - Path pattern: `/product/shopper-products/v1/organizations/{organizationId}/products/{id}`
+     * - Result: dw.util.Map with 2 key:value pairs: `organizationId:sfcc_org` and `id:apple-ipod-shuffle`.
+     */
+    getSCAPIPathParameters(): utilMap<any, any> | null;
+    /**
+     * Returns the SCAPI path pattern in the following way:
+     * 
+     * - The first three segments `/api-family/api-name/version` with concrete values.
+     * - The /organizations part with the path parameter name `organizationId` in curly brackets.
+     * - The actual resource path additional path parameter names in curly brackets.
+     * 
+     * Returns null if isSCAPI returns false i.e. if the request is not a SCAPI request.
+     * 
+     * For example, in the context of a request to get a single product from shopper-products API, this method would
+     * return `/product/shopper-products/v1/organizations/{organizationId}/products/{id}`
+     */
+    getSCAPIPathPattern(): string | null;
+    /**
+     * Returns the session associated with this request.
+     */
+    getSession(): Session;
+    /**
+     * Returns the form that was submitted by the client if the request represents a form submission.
+     */
+    getTriggeredForm(): Form;
+    /**
+     * Returns the form action that was triggered by the client if the request represents a form submission.
+     */
+    getTriggeredFormAction(): FormAction;
+    /**
+     * Identifies if this request is an HTTP request. The method returns true, if the current processing is related to a
+     * HTTP request.
+     * @deprecated Effectively always returns true.
+     */
+    isHttpRequest(): boolean;
+    /**
+     * Returns whether the HTTP communication is secure, which basically means that the communication happens via https.
+     * If the current activity is not related to an HTTP request the method returns false.
+     */
+    isHttpSecure(): boolean;
+    /**
+     * Returns true if the request represents a request for a remote include, false if it is a top-level request.
+     */
+    isIncludeRequest(): boolean;
+    /**
+     * Returns whether the request originated in SCAPI.
+     */
+    isSCAPI(): boolean;
+    /**
+     * Sets the physical location for the current request and remembers the new
+     * value for the duration of the user session. So any subsequent calls to
+     * dw.system.Request.getGeolocation will return this value
+     */
+    setGeolocation(geoLocation: Geolocation): void;
+    /**
+     * Sets the given locale for the request. The locale is only set if it is valid, if it is active and if it is
+     * allowed for the current site.
+     */
+    setLocale(localeID: string): boolean;
+}
+
+export = Request;