Home > @poq/sdk-sfcc > Configuration
Configuration class
Signature:
export declare class Configuration
Constructors
Constructor |
Modifiers |
Description |
(constructor)(param) |
|
Constructs a new instance of the Configuration class |
Properties
Property |
Modifiers |
Type |
Description |
accessToken? |
|
string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>) |
(Optional) parameter for oauth2 security |
apiKey? |
|
string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>) |
(Optional) parameter for apiKey security |
baseOptions? |
|
any |
(Optional) base options for axios calls |
basePath? |
|
string |
(Optional) override base path |
basePathNS |
|
string |
base path namespace (e.g: basePath + ‘/dw/shop/21.9’) |
currency? |
|
string |
(Optional) Currency code. |
formDataCtor? |
|
new () => any |
(Optional) The FormData constructor that will be used to create multipart form data requests. You can inject this here so that execution environments that do not support the FormData class can still run the generated client. |
locale? |
|
string |
(Optional) API Locale |
password? |
|
string |
(Optional) parameter for basic security |
username? |
|
string |
(Optional) parameter for basic security |
version |
|
string |
SFCC OCAPI Version |
Methods
Method |
Modifiers |
Description |
isJsonMime(mime) |
|
Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json |